Skip to content
Zerro15Public

About

ClassFlow — MVP-платформа для репетиторов: ученики, занятия, оплата и домашние задания.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

27 Commits

Folders and files

Repository files navigation

ClassFlow

MVP-платформа для репетиторов: ученики, занятия, домашние задания и учёт оплат.

ClassFlow помогает собрать повседневную работу репетитора в одном месте: вести учеников, планировать занятия и видеть ближайшие задачи.

Возможности MVP

  • Карточки учеников и расписание занятий
  • Статусы занятий и отметки об оплате
  • Домашние задания
  • Дашборд ближайших занятий

Стек

Часть Технологии
Backend FastAPI, SQLAlchemy, Alembic
Frontend Next.js App Router, Tailwind CSS, shadcn/ui
Данные PostgreSQL
Запуск Docker Compose

Быстрый запуск

Нужен установленный Docker с поддержкой Docker Compose.

cp .env.example .env
docker compose up --build

После запуска:

Переменные окружения

Заполни значения в .env на основе .env.example:

Переменная Назначение
DATABASE_URL Подключение к PostgreSQL
JWT_SECRET Секрет для JWT
FRONTEND_ORIGIN Адрес frontend для CORS
TAX_PERCENT_DEFAULT Значение налога или комиссии по умолчанию
NEXT_PUBLIC_API_URL Адрес backend для frontend

Проверки

Backend-команды выполняются в контейнере backend:

pytest
ruff check .
mypy app

Frontend:

npm run lint
npm run typecheck

Структура проекта

backend/  FastAPI, SQLAlchemy и Alembic
frontend/ Next.js-интерфейс
infra/    заметки по инфраструктуре
docs/     спецификация и описание API

Документация

Статус

Проект находится на стадии MVP. Для простоты токен авторизации сейчас хранится в localStorage; перед production-развёртыванием стоит перейти на более безопасную схему хранения, например httpOnly cookie.

Скриншот интерфейса

Экран входа в приложение:

Экран входа ClassFlow

About

ClassFlow — MVP-платформа для репетиторов: ученики, занятия, оплата и домашние задания.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages