Skip to content

Commit 040656a

Browse files
authored
Update README.md to clarify docker-compose.yml purpose
1 parent a0eeb90 commit 040656a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
6. [Contributing](/CONTRIBUTING.md)
1111
7. [License](/LICENSE)
1212

13-
## Quickstart
13+
## Developer Quickstart
1414

15-
Welcome to the project! Follow these steps to get up and running quickly.
15+
Welcome to the project! Follow these steps to get the service up and running for development.
1616

1717
### 1. Setup Configuration
1818

@@ -76,18 +76,20 @@ POSTGRES_DEBUG_PORT=5432 # Expose PostgreSQL on host port for debugging
7676
7777
**Steps**
7878
79-
1. Start the API Server:
79+
1. [Setup your Python Environment](#python-environment-setup)
80+
81+
2. Start the API Server:
8082
8183
```bash
8284
fastapi dev src/app/main.py
8385
```
8486
85-
2. Congrats! It's working! 🎉
87+
3. Congrats! It's working! 🎉
8688

8789
- API Documentation: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
8890
- Health Check Endpoint: [http://127.0.0.1:8000/api/v1/health/ping](http://127.0.0.1:8000/api/v1/health/ping)
8991

90-
## Developer Setup
92+
## Python Environment Setup
9193

9294
**Prerequisites**
9395
- Install [Python 3.12+](https://www.python.org/downloads/).
@@ -262,4 +264,4 @@ This workflow automatically creates GitHub tagged releases based on the tag of t
262264
263265
**Secrets:**
264266
* `AUTO_RELEASE_APP_PRIVATE_KEY`
265-
* `AUTO_RELEASE_APP_ID`
267+
* `AUTO_RELEASE_APP_ID`

0 commit comments

Comments
 (0)