40 lines
1 KiB
Markdown
40 lines
1 KiB
Markdown
# Steady
|
|
|
|
Steady is an ADHD-friendly task manager built with Flask. Phase 1 provides the
|
|
application factory, database and migration setup, secure authentication, and
|
|
the shared visual foundation.
|
|
|
|
## Local setup
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
python -m pip install -r requirements.txt
|
|
flask --app app run --debug
|
|
```
|
|
|
|
The development server is available at `http://127.0.0.1:5000`. Copy
|
|
`.env.example` to `.env` or export its values in your shell. Replace the sample
|
|
`SECRET_KEY` before using the app beyond local development.
|
|
|
|
## Database migrations
|
|
|
|
Apply the committed migrations after installing dependencies:
|
|
|
|
```bash
|
|
flask --app app db upgrade
|
|
```
|
|
|
|
When a model changes, generate a migration with
|
|
`flask --app app db migrate -m "Describe the schema change"`, review the
|
|
generated operations, and commit them so every environment applies the same
|
|
schema.
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
python -m pytest
|
|
```
|
|
|
|
Tests use an isolated in-memory SQLite database and never write to the local
|
|
development database.
|