chore: clean up readme and add MIT license

This commit is contained in:
Stijnvandenbroek
2026-03-09 10:11:16 +00:00
parent f8c61918d5
commit 0a44b8773d
2 changed files with 23 additions and 31 deletions

View File

@@ -17,7 +17,7 @@ Two listings are shown side-by-side. You pick the one you prefer, and both recei
```
┌──────────┐ ┌──────────┐ ┌────────────┐
│ Frontend │─nginx──│ Backend │────────│ PostgreSQL │
│ Frontend │─nginx──│ Backend │────────│ PostgreSQL │
│ React/TS │ :80 │ FastAPI │ :5432 │ │
└──────────┘ └──────────┘ └────────────┘
```
@@ -158,35 +158,6 @@ make logs Tail service logs
make clean Remove caches and build artifacts
```
## Project structure
```
├── .env.example # Environment variable template
├── .github/workflows/ci.yaml # CI pipeline (lint + test)
├── .pre-commit-config.yaml # Pre-commit hooks
├── Makefile # Developer commands
├── docker-compose.yaml # Container orchestration
├── backend/
│ ├── Dockerfile
│ ├── pyproject.toml # Python deps and tool config
│ ├── .sqlfluff # SQL linter config
│ ├── app/
│ │ ├── config.py # Settings and SQL loader
│ │ ├── database.py # DB engine and session
│ │ ├── elo.py # ELO calculation
│ │ ├── main.py # FastAPI application
│ │ ├── models.py # SQLAlchemy ORM models
│ │ ├── queries.py # Shared query helpers
│ │ ├── schemas.py # Pydantic request/response models
│ │ ├── routers/ # API route handlers
│ │ └── sql/ # SQL query templates
│ └── tests/ # Unit tests
└── frontend/
├── Dockerfile
├── nginx.conf # Reverse proxy config
└── src/ # React application
```
## License
MIT
[MIT](LICENSE)