Skip to content

Getting Started

MedScan Wiki edited this page Oct 19, 2026 · 1 revision

Getting started

Full detail: docs/development.md and docs/API_KEYS.md.

Prerequisites

  • Python 3.11+
  • Node 20+
  • Flutter 3.x (only if you touch Android)
  • Optional: Tesseract, Playwright Chromium (playwright install chromium)

1. API

cd backend
python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r requirements-dev.txt
copy .env.example .env
python run.py

API: http://127.0.0.1:5000 · health: GET /health

Sign-in needs Supabase env vars — see docs/SUPABASE_AUTH.md.

2. Web

cd frontend
npm install
npm run dev

Open http://localhost:5173. Vite proxies /api to the backend.

3. Android (optional)

cd mobile
flutter pub get
flutter run --dart-define=API_BASE_URL=http://10.0.2.2:5000

Before a PR

cd backend;  .\venv\Scripts\python.exe -m pytest tests/ -q
cd frontend; npm run lint; npm run build
cd mobile;   flutter analyze; flutter test

Docker

docker compose up --build

Common snags

Symptom Fix
Search stuck “pending” playwright install chromium or SKIP_PLAYWRIGHT=1
403 Invalid client API key Match VITE_MEDSCAN_API_KEY / MEDSCAN_API_KEY to MEDSCAN_CLIENT_API_KEYS
Google deleted_client Recreate OAuth client in Google Cloud → Supabase

More: docs/development.md.

Clone this wiki locally