Skip to content
This repository was archived by the owner on Nov 23, 2025. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,44 @@
# 🗓️ Appointment & Scheduling Service

## 🚦 Build Status

**main**

[![Build and Test Appointment Service](https://github.com/TechTorque-2025/Appointment_Service/actions/workflows/buildtest.yaml/badge.svg)](https://github.com/TechTorque-2025/Appointment_Service/actions/workflows/buildtest.yaml)

**dev**

[![Build and Test Appointment Service](https://github.com/TechTorque-2025/Appointment_Service/actions/workflows/buildtest.yaml/badge.svg?branch=dev)](https://github.com/TechTorque-2025/Appointment_Service/actions/workflows/buildtest.yaml)

This microservice handles all aspects of appointment booking and work scheduling.

**Assigned Team:** Aditha, Chamodi

### 🎯 Key Responsibilities

- Allow customers to book new appointments for their vehicles.
- Manage the status of appointments (e.g., `PENDING`, `CONFIRMED`, `COMPLETED`).
- Provide a public endpoint to check for available time slots.
- Allow employees to view their daily work schedules.
- Allow customers to book new appointments for their vehicles.
- Manage the status of appointments (e.g., `PENDING`, `CONFIRMED`, `COMPLETED`).
- Provide a public endpoint to check for available time slots.
- Allow employees to view their daily work schedules.

### ⚙️ Tech Stack

- **Framework:** Java / Spring Boot
- **Database:** PostgreSQL
- **Security:** Spring Security (consumes JWTs)
![Spring Boot](https://img.shields.io/badge/Spring_Boot-6DB33F?style=for-the-badge&logo=spring-boot&logoColor=white) ![PostgreSQL](https://img.shields.io/badge/PostgreSQL-4169E1?style=for-the-badge&logo=postgresql&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)

- **Framework:** Java / Spring Boot
- **Database:** PostgreSQL
- **Security:** Spring Security (consumes JWTs)

### ℹ️ API Information

- **Local Port:** `8083`
- **Swagger UI:** [http://localhost:8083/swagger-ui.html](http://localhost:8083/swagger-ui.html)
- **Local Port:** `8083`
- **Swagger UI:** [http://localhost:8083/swagger-ui.html](http://localhost:8083/swagger-ui.html)

### 🚀 Running Locally

This service is designed to be run as part of the main `docker-compose` setup from the project's root directory.

```bash
# From the root of the TechTorque-2025 project
docker-compose up --build appointment-service
docker-compose up --build appointment-service
```