commencer

Beginnt ( q-auth )

Einfache Authentifizierungsintegration für Anfänger -Entwicklerprojekte

Überblick

Begincer vereinfacht die Integration der Authentifizierung in Ihre Projekte und bietet ein schnelles und problemloses Setup an.

Abschnitte:

1. Für Entwickler, die das NPM -Paket / das Repository als Vorlage verwenden

Schritt 1: Für die Installation des Pakets über NPM installiert

 npx commencer

Oder klonen Sie das Repo direkt

Schritt 2: Konfigurieren Sie Ihre MySQL -Datenbank -URL in der .env -Datei unter COMMENCER_DATABASE_URL

Schritt 3: Erzeugen Sie Prisma -Dateien:

 npx prisma generate

Schritt 4: Migrationen bereitstellen:

 npx prisma migrate deploy

---

2. Für Mitwirkende

Beiträge sind willkommen !? Befolgen Sie diese Schritte, um einen Beitrag zu leisten:

1. Geben Sie das Repository auf.

2. Erstellen Sie eine neue Filiale für Ihre Funktion oder Ihre Fehlerbehebung.

3. Bühne und begehen Sie Ihre Änderungen:

 git add <file-path> 
git commit -m "Detailed message about changes"

4. Drücken Sie in Ihren Zweig und erstellen Sie eine Pull -Anfrage.

Zusätzliche Git -Befehle:

Veränderungen im Bühnen:

 git add <file-path>

Änderungen zu begehen:

 git commit # opens vim editor

Für eine einfache Commit -Nachricht (nicht empfohlen):

 git commit -m "<message>"

---

3.. Benutzerregistrierungsprozess

1. Nach der Registrierung erhalten Benutzer eine OTP per E -Mail.
2. Benutzer müssen den OTP überprüfen, um die Registrierung abzuschließen.
3. Eine erneute Registrierung ist nicht zulässig, wenn sich die E-Mail bereits in der Datenbank befindet, unabhängig vom OTP-Überprüfungsstatus.

---

4. API -Endpunkte Beschreibung

Die Datei /src/routes/user/index.ts definiert mehrere Authentifizierungsendpunkte. Einige unten aufgeführte Routen sind mit /auth/ vorangestellt.

---

1. POST /auth/register-user

• Eingabe :

  • userID (Zeichenfolge): Die ID des Benutzers.
  • idType (Zeichenfolge): Der ID -Typ des Benutzers (kann mobile / email sein).
  • name (Zeichenfolge): Der Name des Benutzers.

• Controller :
  Registriert einen neuen Benutzer und sendet ein OTP für E -Mail/Mobile, wie zur Überprüfung erwähnt.

---

2. POST /auth/login

• Eingabe :

  • userID (Zeichenfolge): Die ID des Benutzers.
  • password (Zeichenfolge): Das Kennwort des Benutzers.

• Controller :
  Authentifiziert den Benutzer und gibt ein Sitzungs -Token für eine erfolgreiche Anmeldung zurück.

---

3.. PUT /auth/reset-password

• Eingabe :
  • otp (Nummer): Der OTP ist erforderlich.
  • userID (Zeichenfolge): Die ID des Benutzers.
  • password (Zeichenfolge): Das Kennwort des Benutzers.
• Controller :
  Setzt das Kennwort für den vorhandenen Benutzer mit den genannten Eingaben zurück (mithilfe von PUT -Methode).

---

4. PUT /auth/set-password

• Eingabe :

  • otp (String): Der erforderliche OTP.
  • userID (Zeichenfolge): Die ID des Benutzers.
  • password (Zeichenfolge): Das Kennwort des Benutzers.

• Controller :
  Erstellt ein Passwort für das Benutzerkonto (falls sie noch nie einen festgelegt haben) mit einem gültigen OTP (über die PUT -Methode).

---

Beitragsleitfaden

Erstellen Sie einen Diskussionsthread, um Prozesse zu klären und Verbesserungen vorzuschlagen.

Feedback und Unterstützung

Fühlen Sie sich frei, Probleme oder Diskussionen zu öffnen, wenn Sie Hilfe benötigen oder Probleme haben. Beiträge und Vorschläge werden sehr ermutigt, das Repository zu verbessern.

---