Installation Instructions

Follow these steps to set up and run the Appointment Booking System locally.

1. Clone the Repository

git clone https://github.com/yourusername/appointment-booking-system.git
cd AppointmentBooking

2. Install Dependencies

Install dependencies for each backend service:

cd BACKEND/MainGateway && npm install
cd ../userService && npm install
cd ../appointmentService && npm install
cd ../adminService && npm install
cd ../notificationService && npm install

Install frontend dependencies:

cd ../../FRONTEND
npm install

Install admin dashboard dependencies:

cd ../DASHBOARD
npm install

3. Configure Environment Variables

Create a .env file for each backend service and add the required configuration, including:

• MongoDB connection string
• JWT secret
• Redis configuration
• RabbitMQ configuration
• Email service credentials
• Service ports

4. Start Backend Services

Open separate terminal windows and start each service:

cd BACKEND/MainGateway
npm start
cd BACKEND/userService
npm start
cd BACKEND/appointmentService
npm start
cd BACKEND/adminService
npm start
cd BACKEND/notificationService
npm start

5. Start the Frontend Applications

User Frontend:

cd FRONTEND
npm run dev

Admin Dashboard:

cd DASHBOARD
npm run dev

6. (Optional) Run with Docker

Start all services using Docker Compose:

docker-compose up --build

Stop all containers:

docker-compose down

Application URLs

ApplicationURLUser Frontendhttp://localhost:5173Admin Dashboardhttp://localhost:5174API Gatewayhttp://localhost:5000

Usage Instructions

After successfully installing and running all services, open the application in your web browser.

User Application

1. Open the User Frontend at http://localhost:5173.
2. Register a new account or log in with existing credentials.
3. Browse available appointment slots.
4. Book, view, or manage your appointments.
5. Receive confirmation emails after successful bookings.

Admin Dashboard

1. Open the Admin Dashboard at http://localhost:5174.
2. Log in as an administrator.
3. View and manage all appointments.
4. Monitor users and update appointment-related information.
5. Perform administrative operations through the dashboard.

System Workflow

1. Users interact with the User Frontend or Admin Dashboard.
2. Requests are sent to the API Gateway.
3. The gateway routes requests to the appropriate microservice.
4. Services process the request and communicate with MongoDB, Redis, and RabbitMQ as required.
5. The Notification Service sends email confirmations asynchronously, while Redis improves response time by caching frequently accessed data.

System Requirements

Hardware Requirements

ComponentMinimum RequirementProcessorDual-Core CPU (Intel Core i3/AMD Ryzen 3 or equivalent)RAM4 GB (8 GB Recommended)Storage2 GB free disk spaceInternetRequired for package installation and email services

Software Requirements

SoftwareVersionOperating SystemWindows, Linux, or macOSNode.jsv18 or laternpmv9 or laterMongoDBv6.0 or laterRedisLatest stable versionRabbitMQLatest stable versionDocker & Docker ComposeOptional (for containerized deployment)GitLatest stable versionCode EditorVisual Studio Code (Recommended)Web BrowserGoogle Chrome, Microsoft Edge, Firefox, or any modern browser