Likert-o-mat 2.0

Eine moderne und flexible Lösung für die Erstellung und Verwaltung von Likert-Skala-basierten Umfragen.

Open-Source · 100% TypeScript · Next.js

Über das Projekt

Likert-o-mat 2.0 ist eine Open-Source-Anwendung zur Erstellung und Verwaltung von Umfragen basierend auf der Likert-Skala. Die App wurde vollständig mit Next.js und Prisma entwickelt und bietet eine moderne, benutzerfreundliche Oberfläche für Forscher, Pädagogen und andere Fachleute. Dieses Projekt wird von re:edu entwickelt und gepflegt.

Funktionen

• 📊 Erstellung und Verwaltung von Likert-Skala-Umfragen
• 🔐 Passwortlose Authentifizierung mit Magic Links
• 💳 Integrierte PayPal-Zahlungsabwicklung
• 📧 Integriertes E-Mail-System für Benachrichtigungen
• 📈 Echtzeit-Datenanalyse und Visualisierung
• 👥 Rollenbasierte Zugriffskontrolle (RBAC)
• 💾 Robuste Datenbankunterstützung mit PostgreSQL
• 🎨 Responsive und moderne Benutzeroberfläche
• 🌐 Mehrsprachige Unterstützung
• 📱 Mobile-First Design
• 🔄 Echtzeit-Updates und Synchronisation
• 💰 Flexibles Abrechnungsmodell mit verschiedenen Zahlungsoptionen

Verwendete Technologien

• Next.js - React Framework
• Prisma - ORM
• PostgreSQL - Datenbank
• NextAuth.js - Authentifizierung
• Tailwind CSS - CSS-Framework
• TypeScript - Programmiersprache
• Chart.js - Datenvisualisierung
• Docker - Containerisierung
• Resend - E-Mail-Service
• shadcn/ui - UI-Komponenten
• PayPal SDK - Zahlungsabwicklung

Authentifizierung

Likert-o-mat 2.0 verwendet eine moderne, passwortlose Authentifizierung mit Magic Links:

1. Magic Link Anmeldung

   • Benutzer geben ihre E-Mail-Adresse ein
   • Ein einmaliger Anmeldelink wird per E-Mail versendet
   • Sichere, passwortlose Authentifizierung durch Klick auf den Link
   • Zeitlich begrenzte Gültigkeit der Magic Links

2. Sicherheitsmerkmale

   • CSRF-Schutz
   • Sichere Session-Verwaltung
   • Automatische Token-Rotation
   • IP-basierte Ratenbegrenzung

Zahlungsintegration

Die Anwendung bietet eine nahtlose Integration mit PayPal für Zahlungen und Abonnements:

PayPal-Integration

1. Zahlungsoptionen

   • Einmalige Zahlungen für Premium-Funktionen
   • Wiederkehrende Abonnements
   • Flexible Preisgestaltung und Planoptionen

2. Implementierte Funktionen

   • PayPal Smart Buttons
   • Automatische Zahlungsbestätigungen
   • Webhook-Integration für Zahlungsereignisse
   • Abonnementverwaltung
   • Rechnungsstellung und Quittungen

3. Sicherheit

   • Sichere Verarbeitung von Zahlungsinformationen
   • Verschlüsselte Transaktionen
   • Compliance mit Datenschutzbestimmungen

Einrichtung der Zahlungsumgebung

1. PayPal-Konfiguration

   Fügen Sie diese Umgebungsvariablen zu Ihrer .env-Datei hinzu:

   PAYPAL_CLIENT_ID=your-paypal-client-id
   PAYPAL_CLIENT_SECRET=your-paypal-client-secret
   PAYPAL_WEBHOOK_ID=your-webhook-id

2. Webhook-Einrichtung

   # Webhook-URL für Produktionsumgebung
   https://ihre-domain.com/api/webhooks/paypal

Inhaltsverzeichnis

1. Erste Schritte
2. Entwicklungsumgebung einrichten
3. Produktionsumgebung einrichten
4. Beitragen
5. Lizenz
6. Kontakt

Erste Schritte

Diese Anleitung führt Sie durch die Einrichtung sowohl der Entwicklungs- als auch der Produktionsumgebung.

Voraussetzungen

Stellen Sie sicher, dass Sie folgende Tools installiert haben:

• Node.js (Version 20.x oder höher)
• Docker
• yarn oder npm

Entwicklungsumgebung einrichten

1. Klonen Sie das Repository:

   git clone https://github.com/reedu-reengineering-education/likert-o-mat-2.0.git
   cd likert-o-mat-2.0

2. Installieren Sie die Abhängigkeiten:

   yarn install

3. Erstellen Sie eine .env-Datei:

   cp .env.example .env

4. Konfigurieren Sie die Umgebungsvariablen: Bearbeiten Sie die .env-Datei und setzen Sie die erforderlichen Werte:

   DATABASE_URL=postgresql://postgres:postgres@localhost:5432/likert-o-mat
   NEXTAUTH_SECRET=your-secret-key
   RESEND_API_KEY=your-resend-api-key
   PAYPAL_CLIENT_ID=your-paypal-client-id
   PAYPAL_CLIENT_SECRET=your-paypal-client-secret
   PAYPAL_WEBHOOK_ID=your-webhook-id

5. Starten Sie die Entwicklungsdatenbank:

   docker compose up -d

6. Führen Sie die Prisma-Migrationen aus:

   npx prisma migrate dev

7. Starten Sie die Entwicklungsumgebung:

   yarn dev

Produktionsumgebung einrichten

1. Bauen Sie die Anwendung:

   yarn build

2. Starten Sie den Produktionsserver:

   yarn start

3. Mit Docker:

   docker compose -f docker-compose.prod.yml up -d

Beitragen

Wir freuen uns über Beiträge! Wenn Sie eine Verbesserung vorschlagen möchten:

1. Forken Sie das Projekt
2. Erstellen Sie einen Feature-Branch (git checkout -b feature/AmazingFeature)
3. Committen Sie Ihre Änderungen (git commit -m 'Add some AmazingFeature')
4. Pushen Sie den Branch (git push origin feature/AmazingFeature)
5. Öffnen Sie einen Pull Request

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert. Weitere Informationen finden Sie in der LICENSE-Datei.

Kontakt

re:edu GmbH - @reedu_de - [email protected]

Projektlink: https://github.com/reedu-reengineering-education/likert-o-mat-2.0