chore: clean up readme and add MIT license
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Stijnvandenbroek
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
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 │ │
|
│ React/TS │ :80 │ FastAPI │ :5432 │ │
|
||||||
└──────────┘ └──────────┘ └────────────┘
|
└──────────┘ └──────────┘ └────────────┘
|
||||||
```
|
```
|
||||||
@@ -158,35 +158,6 @@ make logs Tail service logs
|
|||||||
make clean Remove caches and build artifacts
|
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
|
## License
|
||||||
|
|
||||||
MIT
|
[MIT](LICENSE)
|
||||||
|
|||||||
Reference in New Issue
Block a user