user service

ANSOPEDIA User Service

Der ANSOPEDIA -Benutzerdienst ist ein Backend -Dienst, der für die Verwaltung von Benutzerkonten und Authentifizierung innerhalb der Ansopedia -Lernplattform verantwortlich ist. Es bietet Funktionen wie:

• Benutzerregistrierung und Anmeldung: Ermöglicht Benutzern, neue Konten zu erstellen und sich sicher bei der Plattform anzumelden.
• Benutzerverwaltung: Bietet APIs zum Verwalten von Benutzerprofilen, Vorlieben und potenziellen Benutzerrollen (falls die Berechtigungsstufen vorhanden).
• Authentifizierung: Implementiert robuste Authentifizierungsmechanismen (z. B. JWT -Token), um den Zugang zu Ansopedia -Funktionen und -Ressourcen zu sichern.
• Integration: Arbeiten mit anderen Diensten wie der Ansopedia Studio -API zusammen, um Benutzerberechtigungen für die Erstellung und Interaktion von Inhalten zu verwalten.

Die Skripte verstehen

Bevor wir uns mit den Schritten befassen, lass uns die Skripte in Ihrer Datei package.json aufschlüsseln:

• Build: Transpiles TypeScript -Code in JavaScript.
• Dev: Startet den Entwicklungsserver mit Nodemon zum heißen Nachladen.
• Lint: FININT die Codebasis mit Eslint.
• FINT: Fix: Behebt automatisch Fusselfehler.
• Vorbereiten: Läuft Husky Pre-Commit-Haken.
• Pretest: Erstellt das Projekt, bevor Tests durchgeführt werden.
• Schöner: Überprüfen Sie: Überprüfung der Code -Formatierung.
• Schöner: Fix: Behebung der Code -Formatierung automatisch.
• prod: setzt das node_env auf produzieren, erstellt das Projekt und startet den Server.
• Start: Startet den Entwicklungsserver mit dem TS-Knoten.
• Test: Leitet die Testsuite.

Entwicklungsumfeld

1. Abhängigkeiten installieren:

   pnpm install

2. Development Server starten:

   pnpm dev

   Dieser Befehl startet einen Nodemon -Server, auf dem Änderungen in Ihren Typenkriptateien beobachtet und der Server automatisch neu gestartet wird.

Produktionsumgebung

1. Starten Sie den Produktionsserver:

   pnpm prod

   Dieser Befehl legt den NODE_ENV auf production fest, erstellt das Projekt und startet den Server.

Testumgebung

1. Tests ausführen:

   pnpm test

Zusätzliche Skripte

• Linie:
  • Überprüfen Sie Probleme mit dem Code -Stil: pnpm lint
  • Automatisch Probleme mit dem Code -Stil reparieren: pnpm lint:fix
• Formatierung:
  • Fragen Sie nach Codeformatierungsproblemen: pnpm prettier:check
  • Automatisch Probleme mit der Code -Formatierung Problemen: pnpm prettier:fix

Lizenz

Durch den Beitrag stimmen Sie zu, dass Ihre Beiträge im Rahmen der Projektlizenz lizenziert werden.

Beitragen

Wir begrüßen Beiträge zum Ansopedia Creator Studio! Bitte lesen Sie unseren Beitrag für weitere Informationen.

Verhaltenskodex

Wir haben eine code_of_conduct.md, die unsere Erwartungen an das Verhalten in der Community beschreibt. Bitte lesen Sie es.

Mitwirkende

Wir begrüßen alle Mitwirkenden des Ansopedia Creator Studio.

Sicherheitsschlüsseleinrichtungen

Für JWT Token Signing und Überprüfung erfordert dieser Service RSA -Schlüsselpaare.

Entwicklungsaufbau

1. Erstellen Sie ein keys in der Projektrohne
2. Führen Sie das Skript der Schlüsselgenerierung aus:

npm run generate-keys

Produktionssetup

Für Produktionsumgebungen sollten die Schlüssel sein:

• Sicher offline generiert
• In einem sicheren wichtigen Verwaltungsdienst gespeichert
• Als Geheimnisse im Container/der Umgebung montiert
• Nie der Versionskontrolle verpflichtet

Die erwarteten Schlüsseldateien sind:

• /keys/private.pem - RSA Privatschlüssel (Keep Seid!)
• /keys/public.pem - RSA Public Key (kann verteilt werden)