Skip to content

Commit a1fc60d

Browse files
committed
refactor: update README.md
1 parent c2313b3 commit a1fc60d

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Leetcode Microservices
22

3-
> Coding practice platform
4-
53
A fully-featured, scalable LeetCode-style online judge built using a modern microservices architecture.
64
Includes real-time code execution, WebSockets, problem solving interface with Monaco Editor, authenticated user system, distributed queues, and Docker-based isolated execution.
75

@@ -22,6 +20,17 @@ This project uses a microservices architecture with 7 independent services commu
2220
| **Submissions Service** | 5006 | Code submission tracking and history |
2321
| **Execution Service** | 5007 | Async code execution via BullMQ workers |
2422

23+
## 🎯 Key Features
24+
25+
- Real-time code execution with live feedback
26+
- Monaco Editor with syntax highlighting
27+
- Docker-based sandboxed execution environment
28+
- Distributed job processing with BullMQ
29+
- Full monitoring stack (Prometheus + Grafana + Loki)
30+
- CI/CD pipeline with GitHub Actions
31+
- JWT authentication with refresh tokens
32+
- Email verification and password reset
33+
2534
## ⚙️ Tech Stack
2635

2736
### Frontend
@@ -46,6 +55,16 @@ This project uses a microservices architecture with 7 independent services commu
4655
- JWT authentication
4756
- Event-driven architecture
4857

58+
### DevOps & Infrastructure
59+
60+
- **Docker & Docker Compose** - Containerized microservices orchestration
61+
- **GitHub Actions** - Automated CI/CD pipeline
62+
- **Prometheus** - Metrics collection and monitoring
63+
- **Grafana** - Visualization dashboards for system metrics
64+
- **Loki** - Centralized log aggregation
65+
- **BullMQ + Redis** - Distributed job queues for async processing
66+
- **Nginx** - Reverse proxy and load balancing
67+
4968
## ⚙️ Execution Pipeline
5069

5170
- User clicks "Submit" → Frontend sends code via WebSocket to API Gateway
@@ -110,6 +129,19 @@ $ pnpm install
110129
$ pnpm dev
111130
```
112131

132+
### 📊 Monitoring Dashboards
133+
134+
After running `docker compose up`, access:
135+
136+
- Grafana: http://localhost:3001 (default: admin/admin)
137+
- Prometheus: http://localhost:9090
138+
139+
### 🧪 Running Tests
140+
141+
```bash
142+
$ pnpm test
143+
```
144+
113145
## 📡 API Features (OpenAPI 3.0)
114146

115147
This project includes a complete OAS 3.0 compliant REST API.

0 commit comments

Comments
 (0)