Zum Hauptinhalt springen

School-SaaS Developer Documentation

Willkommen zur technischen Dokumentation der School-SaaS Plattform!

Über dieses Projekt​

School-SaaS ist eine moderne, cloud-basierte Schulverwaltungssoftware, die speziell für deutsche Schulen entwickelt wurde. Die Plattform bietet:

  • 🏫 Multi-Tenant-Architektur - Jede Schule hat ihre eigene isolierte Umgebung
  • 👥 Umfassendes Schülermanagement - Schülerdaten, Guardians, Trusted Persons
  • 📚 Klassenverwaltung - Klassen, Fächer, Stundenpläne
  • 📄 DSGVO-konformes File-Management - Automatisches Retention-Management
  • 💳 Stripe-Integration - Subscription-Management
  • 🔐 Moderne Authentifizierung - Auth.js mit GitHub OAuth

Tech Stack​

Frontend​

  • Next.js 15 - React Framework mit App Router
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first CSS
  • shadcn/ui - UI-Komponenten
  • React Hook Form - Formular-Handling

Backend​

  • Next.js API Routes - Serverless Functions
  • Prisma ORM - Type-safe Database Access
  • Neon PostgreSQL - Serverless Database
  • Auth.js - Authentication

Infrastructure​

  • Vercel - Hosting & Deployment
  • Vercel Blob - File Storage
  • Stripe - Payment Processing
  • GitHub - Version Control & OAuth

Erste Schritte​

  1. Setup - Projekt lokal aufsetzen
  2. Environment Variables - Konfiguration
  3. First Run - Erstes Starten der App
  4. Project Structure - Verzeichnisstruktur verstehen

Support​

Contributing​

Möchtest du zum Projekt beitragen? Schau dir unseren Contributing Guide an!