Skip to content

ghemrich/openschool-platform

Repository files navigation

OpenSchool Platform

CI License: MIT

Nyílt forráskódú oktatási platform, ahol a tanulók valódi fejlesztői eszközökkel tanulnak programozni.

Az open source nem feature — az open source a tanterv.

Nem csak a szoftver nyílt: a tananyag, az eszközök, az értékelés, a platform kódja — minden látható, minden módosítható.

Tech Stack

  • Backend: FastAPI + SQLAlchemy + Alembic
  • Adatbázis: PostgreSQL
  • Frontend: React 19 + TypeScript + Vite (SPA)
  • Tesztelés: pytest (backend), Vitest + React Testing Library (frontend)
  • Infrastruktúra: Docker Compose, nginx, GitHub Actions

Gyors indítás

Előfeltételek

  • Docker és Docker Compose
  • Python 3.12+ (lokális fejlesztéshez)

Futtatás Docker-rel

# .env fájl létrehozása
cp .env.example .env

# Indítás
docker compose up --build -d

# Ellenőrzés
curl http://localhost:8000/health

Lokális fejlesztéshez lásd: Telepítés és fejlesztői környezet

Közösség

Csatlakozz a Discord szerverünkhöz: discord.gg/BrKd45S6

Hozzájárulás

Szívesen fogadjuk a hozzájárulásokat! Lásd: CONTRIBUTING.md

Dokumentáció

Dokumentum Leírás
Telepítés Fejlesztői környezet, env vars, Docker, Makefile
Architektúra Rendszer felépítés, adatmodell, auth, infrastruktúra
Backend FastAPI routers, services, Ruff, pytest, Alembic
Frontend React + TypeScript, oldalak, API, tesztelés
Telepítés és üzemeltetés VPS, SSH, DNS, SSL, CI/CD, staging, cron, secrets
Karbantartás Workflow, minőségkapuk, monitoring, incidenskezelés
API referencia Összes végpont, sémák, státuszkódok
Adatbázis séma Táblák, kapcsolatok, migrációk
Integrációk Discord, GitHub Classroom
Roadmap Jövőkép, megvalósított és tervezett funkciók

Kapcsolódó repók

Repó Leírás
openschool-knowledge Kurzusanyagok, útmutatók, vizsgák, értékelési módszertanok

A good first issue címkéjű issue-k ideálisak kezdőknek.

Licensz

A projekt az MIT License alatt érhető el.