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方法）為用戶帳戶創建一個密碼（如果他們以前從未設置過一個）。

---

貢獻指南

為了貢獻，創建討論線程以闡明過程並提出改進。

反饋和支持

如果您需要幫助或遇到任何問題，請隨時打開問題或討論。強烈建議提出貢獻和建議來改善存儲庫。

---