Kharec/flado
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2025-12-03 19:46:41 +01:00
parent cf48f420f9
commit 05a3a636fe
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -16,26 +16,24 @@ I hacked it overnight, mainly to refresh my (very poor) frontend skills.
## Quick Start (for development) ## Quick Start (for development)
```bash ```bash
# 1. Create and activate a virtual environment # 1. Install and use uv (https://github.com/astral-sh/uv)
python -m venv .venv uv sync # creates/updates .venv and installs dependencies
source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
# 2. Install dependencies # 2. Set environment variables for Flask
pip install -r requirements.txt
# 3. Set environment variables for Flask
export FLASK_APP=flado.app:create_app export FLASK_APP=flado.app:create_app
export FLASK_ENV=development export FLASK_ENV=development
# 4. Initialize the SQLite database (instance/flado.sqlite by default) # 3. Initialize the SQLite database (instance/flado.sqlite by default)
flask db init uv run flask db init
flask db migrate -m "Initial migration" uv run flask db migrate -m "Initial migration"
flask db upgrade uv run flask db upgrade
# 5. Run the development server # 4. Run the development server
flask run --debug uv run flask run --debug
``` ```
`uv` pins dependencies in `uv.lock` (exported to `requirements.txt` for compatibility). If you prefer `pip`, you can still do `python -m venv .venv && source .venv/bin/activate` followed by `pip install -r requirements.txt`.
The SQLite database file is stored in the `instance/` directory (it remains outside of version control by default). The SQLite database file is stored in the `instance/` directory (it remains outside of version control by default).
## Configuration ## Configuration