Skip to content
This repository was archived by the owner on Nov 23, 2025. It is now read-only.

Commit 1746c22

Browse files
authored
Merge pull request #4 from TechTorque-2025/dev
docs: Add build status badges for all services in README.md for impro…
2 parents 7bec87c + 87bfbdc commit 1746c22

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
# 🌐 API Gateway
22

3+
## 🚦 Build Status
4+
5+
**main**
6+
37
[![Build and Test API Gateway](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml/badge.svg)](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml)
48

9+
**dev**
10+
11+
[![Build and Test API Gateway](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml/badge.svg?branch=dev)](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml)
12+
513
This service is the single entry point for all client requests in the TechTorque 2025 system. It is responsible for routing, authentication, rate limiting, and enriching requests.
614

715
### 🎯 Key Responsibilities
816

9-
- **Request Routing:** Maps incoming URL paths (e.g., `/api/v1/vehicles`) to the correct internal microservice (e.g., `vehicle-service`).
10-
- **Authentication:** Validates JWTs for all protected endpoints.
11-
- **Header Enrichment:** Injects `X-User-Subject` and `X-User-Roles` headers into requests after successful authentication.
12-
- **CORS:** Manages all Cross-Origin Resource Sharing policies for the frontend application.
17+
- **Request Routing:** Maps incoming URL paths (e.g., `/api/v1/vehicles`) to the correct internal microservice (e.g., `vehicle-service`).
18+
- **Authentication:** Validates JWTs for all protected endpoints.
19+
- **Header Enrichment:** Injects `X-User-Subject` and `X-User-Roles` headers into requests after successful authentication.
20+
- **CORS:** Manages all Cross-Origin Resource Sharing policies for the frontend application.
1321

1422
### ⚙️ Tech Stack
1523

16-
- **Language:** Go
17-
- **Router:** `chi/v5`
18-
- **JWT Library:** `golang-jwt/jwt/v5`
24+
![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge&logo=go&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
25+
26+
- **Language:** Go
27+
- **Router:** `chi/v5`
28+
- **JWT Library:** `golang-jwt/jwt/v5`
1929

2030
### 🚀 Running Locally
2131

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

2434
```bash
2535
# From the root of the TechTorque-2025 project
26-
docker-compose up --build api-gateway
36+
docker-compose up --build api-gateway
37+
```

0 commit comments

Comments
 (0)