AI-powered adaptive learning platform for Nigerian students — WAEC, JAMB, NECO prep. Multi-lingual (English, Hausa, Yoruba, Igbo, Pidgin, French, Arabic). Built in Nigeria for Africa.
# Zylvex AI Tutor
**AI-powered adaptive learning platform for Nigerian students.**
Master WAEC, JAMB, and NECO with AI that identifies your weak areas and drills them until you excel.
Built in Nigeria, for Africa.
## Quick Start
```bash
# Start everything (database, backend, frontend)
docker compose up -d
# Seed the database (first time only)
docker compose exec backend python -m app.seed.seed_data
# Open the app
open
localhost
```
## Run Without Docker
### Backend
```bash
cd backend
cp .env.example .env
pip install -r requirements.txt
python -m app.seed.seed_data
uvicorn app.main:app --reload --port 8000
```
### Frontend
```bash
cd web
npm install
npm run dev
```
## Architecture
```
zylvex-ai-tutor/
├── backend/ # FastAPI + PostgreSQL
│ ├── app/
│ │ ├── core/ # Config, DB, Security
│ │ ├── models/ # SQLAlchemy models
│ │ ├── schemas/ # Pydantic schemas
│ │ ├── api/v1/ # REST endpoints
│ │ └── seed/ # Seed data
│ └── requirements.txt
├── web/ # React + Vite + Tailwind
│ ├── src/
│ │ ├── pages/ # Route pages
│ │ ├── components/
│ │ ├── store/ # Auth state
│ │ ├── api/ # API client
│ │ └── i18n/ # Multi-lingual
│ └── package.json
├── ml/ # ML models (Phase 4)
├── docker-compose.yml
└── README.md
```
## Subjects (Phase 1)
**JAMB/UTME:** Use of English, Mathematics, Physics, Chemistry, Biology, Economics, Government, Commerce
**WAEC:** Mathematics, English Language (coming Phase 2)
## Languages
- English, Hausa, Yoruba, Igbo, Nigerian Pidgin
## API Endpoints
| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | /api/v1/auth/register | Create account |
| POST | /api/v1/auth/login | Login |
| GET | /api/v1/content/subjects | List subjects |
| GET | /api/v1/content/subjects/{code}/topics | Topic list |
| GET | /api/v1/content/topics/{id}/lessons | Lesson list |
| GET | /api/v1/lessons/{id}/quizzes | Quiz que …