Update README.md

Added more detailed information about tech stack.
master
John Montagu, the 4th Earl of Sandvich 2024-11-21 18:24:35 -08:00
parent ba2b568259
commit 2c5cf3f4ca
Signed by: sandvich
GPG Key ID: 9A39BE37E602B22D
1 changed files with 18 additions and 19 deletions

View File

@ -2,30 +2,29 @@
Scheduling for TF2 Scheduling for TF2
## Tech Stack
- **Frontend:** [Vue 3](https://v3.vuejs.org/) + TypeScript
- **State Management:** [Pinia](https://pinia.vuejs.org/)
- **Backend:** [Flask](https://flask.palletsprojects.com/) + Python
- **ORM:** [SQLAlchemy](https://www.sqlalchemy.org/)
- **Validation:** [Pydantic](https://pydantic-docs.helpmanual.io/)
- [spectree](https://spectree.readthedocs.io/en/latest/index.html) for
OpenAPI documentation
- [Flask-Migrate](https://flask-migrate.readthedocs.io/en/latest/)
(Alembic) for database migrations
- **Database:** [PostgreSQL 17.1](https://www.postgresql.org/docs/17/index.html)
(production) / SQLite (development)
## Setup (dev) ## Setup (dev)
### Frontend
```sh ```sh
# first time setup docker compose up
npm install
npm run dev
``` ```
### Backend App will run at port 8000.
In virtual environment: ## OpenAPI
```sh
# first time setup
pip install -r requirements.txt
flask db migrate
flask run --debug
```
### OpenAPI
The backend will automatically serve its OpenAPI-compliant spec at The backend will automatically serve its OpenAPI-compliant spec at
`/apidoc/openapi.json` which can also be viewed at `/apidoc/redoc` or `/apidoc/openapi.json` which can also be viewed at `/apidoc/redoc` or
@ -34,5 +33,5 @@ The backend will automatically serve its OpenAPI-compliant spec at
To generate the frontend client: To generate the frontend client:
```sh ```sh
npx openapi --input 'http://localhost:5000/apidoc/openapi.json' --output src/client npm run openapi-generate
``` ```