Skip to content

Commit 2e757e8

Browse files
committed
chore: api readme
1 parent 542435a commit 2e757e8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
API backend for QuantResearchStarter
2+
3+
Run the FastAPI app (development):
4+
5+
```bash
6+
export DATABASE_URL="postgresql+asyncpg://postgres:password@db:5432/qrs"
7+
export REDIS_URL="redis://redis:6379/0"
8+
uvicorn src.quant_research_starter.api.main:app --reload --port 8000
9+
```
10+
11+
Run Celery worker:
12+
13+
```bash
14+
celery -A src.quant_research_starter.api.tasks.celery_app.celery_app worker --loglevel=info
15+
```
16+
17+
Notes:
18+
- This scaffold uses Postgres (asyncpg), Redis (Celery broker + pubsub), and JWT auth.
19+
- For production, run workers and web app in separate containers/processes, and use Alembic to manage schema migrations.

0 commit comments

Comments
 (0)