commencer

Commissateur ( Q-AuTH )

Intégration facile d'authentification pour les projets de développement débutants

Aperçu

Commerciner simplifie l'intégration de l'authentification dans vos projets, offrant une configuration rapide et sans tracas.

Sections:

1. Pour les développeurs utilisant le package / référentiel NPM comme modèle

Étape 1: Pour installer le package via NPM

 npx commencer

Ou cloner le repo directement

Étape 2: Configurez votre URL de la base de données MySQL dans le fichier .env sous COMMENCER_DATABASE_URL

Étape 3: générer des fichiers PRISMA:

 npx prisma generate

Étape 4: Déployer les migrations:

 npx prisma migrate deploy

---

2. Pour les contributeurs

Les contributions sont les bienvenues !? Suivez ces étapes pour contribuer:

1. Fourk le référentiel.

2. Créez une nouvelle branche pour votre fonctionnalité ou votre correction de bogue.

3. Établissez-vous et commettez vos changements:

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

4. Poussez vers votre branche et créez une demande de traction.

Commandes GIT supplémentaires:

Pour mettre en scène les changements:

 git add <file-path>

Pour commettre des changements:

 git commit # opens vim editor

Pour un message de validation simple (non recommandé):

 git commit -m "<message>"

---

3. Processus d'enregistrement des utilisateurs

1. Après l'inscription, les utilisateurs recevront un OTP par e-mail.
2. Les utilisateurs doivent vérifier l'OTP pour terminer l'enregistrement.
3. La réinscription n'est pas autorisée si l'e-mail est déjà dans la base de données, quel que soit le statut de vérification OTP.

---

4. Description des points de terminaison API

Le fichier /src/routes/user/index.ts définit plusieurs points de terminaison liés à l'authentification. Certains itinéraires répertoriés ci-dessous sont préfixés avec /auth/ .

---

1. POST /auth/register-user

• Saisir :

  • userID (String): l'ID de l'utilisateur.
  • idType (String): le type d'identification de l'utilisateur (peut être mobile / email ).
  • name (String): le nom de l'utilisateur.

• Contrôleur :
  Enregistre un nouvel utilisateur et envoie un OTP pour le courrier électronique / mobile comme mentionné pour la vérification.

---

2. POST /auth/login

• Saisir :

  • userID (String): l'ID de l'utilisateur.
  • password (chaîne): le mot de passe de l'utilisateur.

• Contrôleur :
  Authentifie l'utilisateur et renvoie un jeton de session sur une connexion réussie.

---

3. PUT /auth/reset-password

• Saisir :
  • otp (numéro): l'OTP requis.
  • userID (String): l'ID de l'utilisateur.
  • password (chaîne): le mot de passe de l'utilisateur.
• Contrôleur :
  Réinitialise le mot de passe de l'utilisateur existant à l'aide des entrées mentionnées (en utilisant la méthode PUT ).

---

4. PUT /auth/set-password

• Saisir :

  • otp (String): l'otp requis.
  • userID (String): l'ID de l'utilisateur.
  • password (chaîne): le mot de passe de l'utilisateur.

• Contrôleur :
  Crée un mot de passe pour le compte de l'utilisateur (s'ils n'en ont jamais mis un auparavant) à l'aide d'un OTP valide (via la méthode PUT ).

---

Guide de contribution

Pour contribuer, créez un fil de discussion pour clarifier les processus et suggérer des améliorations.

Commentaires et soutien

N'hésitez pas à ouvrir des problèmes ou des discussions si vous avez besoin d'aide ou si vous rencontrez des problèmes. Les contributions et les suggestions sont fortement encouragées à améliorer le référentiel.

---