commencer

Commencer ( Q-Auth )

Integración de autenticación fácil para proyectos de desarrollo para principiantes

Descripción general

Commencer simplifica la integración de la autenticación en sus proyectos, ofreciendo una configuración rápida y sin problemas.

Secciones:

1. Para los desarrolladores que usan el paquete / repositorio NPM como plantilla

Paso 1: para instalar el paquete a través de NPM

 npx commencer

O clonar el repositorio directamente

Paso 2: Configure su URL de base de datos MySQL en el archivo .env en COMMENCER_DATABASE_URL

Paso 3: Generar archivos prisma:

 npx prisma generate

Paso 4: Implementar migraciones:

 npx prisma migrate deploy

---

2. Para los contribuyentes

¿Las contribuciones son bienvenidas? Siga estos pasos para contribuir:

1. Bifurca el repositorio.

2. Cree una nueva rama para su función o corrección de errores.

3. Etapa y comete tus cambios:

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

4. Empuje a su sucursal y cree una solicitud de extracción.

Comandos Git adicionales:

Para organizar cambios:

 git add <file-path>

Para confirmar cambios:

 git commit # opens vim editor

Para un simple mensaje de confirmación (no recomendado):

 git commit -m "<message>"

---

3. Proceso de registro de usuarios

1. Después del registro, los usuarios recibirán un OTP por correo electrónico.
2. Los usuarios deben verificar el OTP para completar el registro.
3. No se permite la reinscripción si el correo electrónico ya está en la base de datos, independientemente del estado de verificación OTP.

---

4. Descripción de puntos finales de API

El archivo /src/routes/user/index.ts define varios puntos finales relacionados con la autenticación. Algunas rutas enumeradas a continuación tienen el prefijo con /auth/ .

---

1. POST /auth/register-user

• Aporte :

  • userID (String): la ID del usuario.
  • idType (String): el tipo de ID del usuario (puede ser mobile / email ).
  • name (cadena): el nombre del usuario.

• Controlador :
  Registra un nuevo usuario y envía un OTP para correo electrónico/móvil como se menciona para la verificación.

---

2. POST /auth/login

• Aporte :

  • userID (String): la ID del usuario.
  • password (cadena): la contraseña del usuario.

• Controlador :
  Autentica al usuario y devuelve un token de sesión en un inicio de sesión exitoso.

---

3. PUT /auth/reset-password

• Aporte :
  • otp (número): requerido el OTP.
  • userID (String): la ID del usuario.
  • password (cadena): la contraseña del usuario.
• Controlador :
  Restablece la contraseña para el usuario existente utilizando entradas mencionadas (usando el método PUT ).

---

4. PUT /auth/set-password

• Aporte :

  • otp (cadena): se requiere la OTP.
  • userID (String): la ID del usuario.
  • password (cadena): la contraseña del usuario.

• Controlador :
  Crea una contraseña para la cuenta del usuario (si nunca ha establecido una antes) utilizando un OTP válido (a través del método PUT ).

---

Guía de contribución

Para contribuir, cree un hilo de discusión para aclarar los procesos y sugerir mejoras.

Comentarios y apoyo

Siéntase libre de abrir problemas o discusiones si necesita ayuda o encontrar algún problema. Se recomienda encarecidamente las contribuciones y sugerencias a mejorar el repositorio.

---