@@ -53,21 +53,14 @@ The project supports multiple environments:
5353
5454---
5555
56- # # 🐳 Running with Docker
57- 1. ** Build and run containers:**
56+ 📦 Running the Project
57+ # Build and start the containers
58+ docker-compose up --build
5859
59- ` ` ` bash
60- docker-compose up --build
61-
62- 2. Stop containers:
60+ # Stop the containers
61+ docker-compose down
6362
64- docker-compose down
65-
66- 3. Check running containers:
6763
68- docker ps -a
69-
70-
7164The API will be available at:
7265
7366HTTP → http://localhost:5000/api
@@ -81,7 +74,9 @@ Press F5 or run the project.
8174
8275By default, it uses Development environment with appsettings.Development.json.
8376
84- 📌 Future Enhancements
77+ ---
78+
79+ # # 📌 Future Enhancements
8580Phase 2 – Logging Integration
8681Add Serilog (file + SQL Server sink).
8782
@@ -94,21 +89,19 @@ Add Swagger / Swashbuckle for documentation.
9489
9590Optionally generate client SDK with NSwag.
9691
97- 📬 Sample API Requests
92+ ---
93+
94+ # # 📬 Sample API Requests
9895Create Application
99- http
100- Copy
101- POST /api/Applications
96+ http POST /api/Applications
10297Content-Type: application/json
10398
10499{
105100 " name" : " Payment Service" ,
106101 " environment" : " Production"
107102}
108103Create Error Log
109- http
110- Copy
111- POST /api/ErrorLogs
104+ http POST /api/ErrorLogs
112105Content-Type: application/json
113106
114107{
@@ -120,11 +113,26 @@ Content-Type: application/json
120113 " userId" : " user123" ,
121114 " requestId" : " req-456"
122115}
123- 🤝 Contributing
116+
117+ ---
118+
119+ # # 🤝 Contributing
120+
124121Future phases will be added in branches (phase-2, phase-3, …).
125122Main branch will always contain the latest stable version.
126123
127- 📜 License
124+ ---
125+
126+ # # 📂 Repository Roadmap
127+
128+ phase-1-core-api → Completed Phase 1.
129+ phase-2-logging → Planned logging integration.
130+ phase-3-swagger → Planned API documentation.
131+ main → Always up to date with the latest stable phase.
132+
133+ ---
134+
135+ # # 📜 License
128136This project is licensed under the MIT License.
129137
130138
0 commit comments