Craig
e047d884b6
Backend (uv): FastAPI app with routers (foods, log, targets, OFF proxy), SQLAlchemy models, Pydantic schemas, migration runner + 0001 initial schema, example pytest suite (7 tests). Frontend (npm): Vite 7 + Svelte 5 runes, lib/ (api, stores, scanner, format) per spec §7, placeholder components, example vitest suite (4 tests). SPEC.md §1: registered uvicorn and Vitest (rule §8.3.3).
62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# CalCount
|
|
|
|
A personal, self-hosted calorie counter web app with barcode scanning via phone
|
|
camera and OpenFoodFacts lookup. See [SPEC.md](SPEC.md) for the full spec,
|
|
data model, API design, and development rules (§8 — read it before writing code).
|
|
|
|
## Stack
|
|
|
|
- **Backend:** Python ≥3.12, FastAPI, SQLAlchemy 2, Pydantic 2, SQLite, httpx — managed with **uv**
|
|
- **Frontend:** Svelte 5 (runes) + Vite 7, zxing-wasm barcode fallback — managed with **npm** (Node ≥22.12)
|
|
|
|
## Project layout
|
|
|
|
```
|
|
backend/ FastAPI app (main.py), SQLAlchemy models, Pydantic schemas,
|
|
routers/, services/, migrations/, tests/
|
|
frontend/ Vite + Svelte SPA (src/), lib/ (api, stores, scanner, format),
|
|
components/
|
|
```
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
# Backend (uv creates .venv and installs from uv.lock)
|
|
cd backend
|
|
uv sync
|
|
|
|
# Frontend
|
|
cd frontend
|
|
npm install
|
|
```
|
|
|
|
## Run
|
|
|
|
Two terminals:
|
|
|
|
```bash
|
|
# Terminal 1 — backend on http://localhost:8000
|
|
cd backend
|
|
uv run uvicorn main:app --reload
|
|
|
|
# Terminal 2 — frontend on http://localhost:5173 (proxies /api → :8000)
|
|
cd frontend
|
|
npm run dev
|
|
```
|
|
|
|
The SQLite database (`backend/calcount.db`) is created and migrated
|
|
automatically on backend startup (`backend/migrations/`).
|
|
|
|
## Test
|
|
|
|
```bash
|
|
cd backend && uv run pytest # backend suite
|
|
cd frontend && npm test # frontend suite (vitest)
|
|
```
|
|
|
|
## Build
|
|
|
|
```bash
|
|
cd frontend && npm run build # production build to frontend/dist/
|
|
```
|