commencer

开始（ Q-auth ）

初学者开发项目的简易身份验证集成

概述

Commencer简化了身份验证到您的项目中的集成，提供了快速无忧的设置。

部分：

1。对于使用NPM软件包 /存储库作为模板的开发人员

步骤1：通过NPM安装软件包

 npx commencer

或直接克隆回购

步骤2：在COMMENCER_DATABASE_URL下的.env文件中配置您的mySQL数据库URL

步骤3：生成Prisma文件：

 npx prisma generate

步骤4：部署迁移：

 npx prisma migrate deploy

---

2。对于贡献者

欢迎捐款！？请按照以下步骤做出贡献：

1. 分叉存储库。

2. 为您的功能或错误修复创建一个新的分支。

3. 舞台并进行更改：

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

4. 推到您的分支并创建拉动请求。

其他git命令：

阶段变化：

 git add <file-path>

进行更改：

 git commit # opens vim editor

对于简单的提交消息（不建议）：

 git commit -m "<message>"

---

3。用户注册过程

1. 注册后，用户将通过电子邮件收到OTP。
2. 用户必须验证OTP以完成注册。
3. 如果电子邮件已经在数据库中，无论OTP验证状态如何，则不允许重新注册。

---

4。API端点描述

/src/routes/user/index.ts文件定义了几个与身份验证相关的端点。下面列出的一些路线以/auth/为前缀。

---

POST /auth/register-user

• 输入：

  • userID （字符串）：用户的ID。
  • idType （字符串）：用户的ID类型（可以是mobile / email ）。
  • name （字符串）：用户的名称。

• 控制器：
  注册新用户，并通过提到的验证发送otp供电子邮件/移动设备发送。

---

POST /auth/login

• 输入：

  • userID （字符串）：用户的ID。
  • password （字符串）：用户的密码。

• 控制器：
  身份验证用户并在成功登录时返回会话令牌。

---

3。put PUT /auth/reset-password

• 输入：
  • otp （编号）：所需的OTP。
  • userID （字符串）：用户的ID。
  • password （字符串）：用户的密码。
• 控制器：
  使用上述输入（使用PUT方法）重置现有用户的密码。

---

4。put PUT /auth/set-password

• 输入：

  • otp （字符串）：所需的OTP。
  • userID （字符串）：用户的ID。
  • password （字符串）：用户的密码。

• 控制器：
  使用有效的OTP（通过PUT方法）为用户帐户创建一个密码（如果他们以前从未设置过一个）。

---

贡献指南

为了贡献，创建讨论线程以阐明过程并提出改进。

反馈和支持

如果您需要帮助或遇到任何问题，请随时打开问题或讨论。强烈建议提出贡献和建议来改善存储库。

---