Add development setup guide and shared VS Code config

Clone-to-first-change onboarding, plus .vscode launch/tasks/extensions
so F5 debugs the backend and a task runs both dev servers. Fix the
README manual path to run the backend on 5001 (the frontend proxies
there; the default 5000 loaded nothing).
This commit is contained in:
2026-07-17 14:40:57 -04:00
parent 365b0f2f69
commit 6aaed7de42
5 changed files with 94 additions and 3 deletions

View File

@@ -148,11 +148,13 @@ pip install -r requirements.txt
cp .env.example .env
# Edit .env with your database credentials and secrets.
export FLASK_APP=shopdb
flask db upgrade
flask plugin upgrade-all # per-plugin schema (ADR-008)
flask seed permissions
flask seed settings
flask seed reference-data
flask run
flask run --port 5001 # MUST be 5001 - the frontend dev server proxies here
# Frontend (separate terminal)
cd frontend
@@ -162,7 +164,10 @@ npm run build # production build into frontend/dist (served by Flask)
```
Complete first-run setup at `/setup`, or run `flask seed admin` for a headless
admin account.
admin account. The repo ships VS Code config in `.vscode/` (F5 debugs the
backend; a "Dev site" task runs both servers). A fuller day-one walkthrough,
including VS Code and troubleshooting, is the DEVELOPMENT-SETUP page in the
project wiki.
To import a site's legacy data, use the HTTP import surface: an admin API
token plus the IMPORT-API page in the project wiki drive the whole migration