ClassFlow

Supplementary education management system built with Clean Architecture.

Features:

• Row-Level Security
• JWT Authentication
• Role-Based Access
• Email Verification
• S3 Storage

Stack

Backend - Python, FastAPI
Frontend - TypeScript, React
Database - PostgreSQL, Redis
Infrastructure - Docker, Nginx
Observability - Prometheus, Grafana

Getting Started

1. Clone the repository

git clone https://github.com/Bigbear2006/classflow.git

2. Create backend/.env

JWT_SECRET_KEY=
# leave empty when running on localhost
DOMAIN=.example.com

S3_BUCKET_NAME=
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_ENDPOINT_URL=
S3_REGION_NAME=

POSTGRES_DB=
POSTGRES_HOST=db
POSTGRES_PORT=5432

POSTGRES_USER=postgres
POSTGRES_PASSWORD=

POSTGRES_APP_USER=app_user
POSTGRES_APP_PASSWORD=

REDIS_HOST=redis
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0

NOTI_SEND_API_KEY=
FROM_EMAIL=admin@example.com

GF_SECURITY_ADMIN_PASSWORD=

3. Run

make
# or
docker-compose up --build -d

Open http://localhost in your browser