mirror of
https://github.com/R0m1k3/Reviflow.git
synced 2026-10-11 17:26:20 +02:00
ef20ddf652061b1585cae644e37cd574e108bdf2
Reviflow
Application de Révision Éducative pour enfants dyslexiques (et leurs parents).
Architecture
Unified Monolith : Single Docker Container deployment for maximum simplicity and portability.
- Backend: Python 3.11 (FastAPI)
- Frontend: React + TypeScript (Vite)
- Database: SQLite (
reviflow.db) - AI: OpenRouter (GPT-4o / Gemini Flash)
Getting Started (Dev)
Prerequisites
- Docker & Docker Compose
- Node.js 20+ (optional, if running frontend locally)
- Python 3.11+ (optional, if running backend locally)
One-Click Start (Docker)
This is the recommended way to run the full stack:
# Create .env file with your API Key
echo "OPENROUTER_API_KEY=your_key_here" > .env
# Start everything
docker-compose up --build
Access the app at: http://localhost:8000
Manual Setup (Hybrid)
Backend:
cd backend
poetry install
poetry run uvicorn app.main:app --reload
Frontend:
cd frontend
npm install
npm run dev
Languages
TypeScript
73.6%
Python
24.9%
JavaScript
0.5%
CSS
0.5%
Dockerfile
0.3%
Other
0.2%