data-entry-app/README.md

Data Entry App

Initial MVP implementation of the costing platform described in CLAUDE.MD.

Structure

backend/   FastAPI API, SQLAlchemy models, costing engine, seed data, tests
frontend/  SvelteKit UI scaffold for dashboard and core modules

Backend

Create a virtual environment, install dependencies, then run:

cd backend
pip install -e .
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

API docs will be available at http://localhost:8000/docs on the server itself, or http://<server-ip>:8000/docs from another machine on the same network.

Useful commands:

python -m app.seed
pytest

The backend defaults to SQLite for the prototype and can be switched with the DATABASE_URL environment variable.

Frontend

Install dependencies and start the dev server:

cd frontend
npm install
npm run dev

The frontend dev server now binds to 0.0.0.0, so you can open it from another machine at http://<server-ip>:5173.

By default the browser will call the backend on the same hostname and port 8000. For example, if you open the UI at http://10.0.0.124:5173, it will call http://10.0.0.124:8000.

Useful environment variables:

PUBLIC_API_PORT=8000
PUBLIC_API_BASE_URL=http://10.0.0.124:8000
CORS_ALLOW_ORIGINS=http://10.0.0.124:5173

Set PUBLIC_API_BASE_URL when the API is on a different machine or behind a different public URL. Set CORS_ALLOW_ORIGINS or CORS_ALLOW_ORIGIN_REGEX if you want to narrow backend CORS more tightly than the default private-network allowance.

Delivered in this MVP

• Raw materials with versioned prices
• Mixes with ingredient rows and calculated cost per kg
• Products with transparent cost breakdowns
• Scenario runs with override support
• Power BI-style reporting endpoints
• SvelteKit dashboard and module pages aligned to the API contract