chore: clean up readme and add MIT license
This commit is contained in:
33
README.md
33
README.md
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user