commencer

Commencer ( Q-Auth )

การรวมการรับรองความถูกต้องง่ายสำหรับโครงการ dev เริ่มต้น

ภาพรวม

Commencer ทำให้การรวมการรับรองความถูกต้องเข้ากับโครงการของคุณง่ายขึ้นนำเสนอการตั้งค่าที่รวดเร็วและไม่ยุ่งยาก

ส่วน:

1. สำหรับนักพัฒนาซอฟต์แวร์ที่ใช้แพ็คเกจ / ที่เก็บ NPM เป็นเทมเพลต

ขั้นตอนที่ 1: สำหรับการติดตั้งแพ็คเกจผ่าน NPM

 npx commencer

หรือ โคลน repo โดยตรง

ขั้นตอนที่ 2: กำหนดค่า URL ฐานข้อมูล MySQL ของคุณในไฟล์ .env ภายใต้ COMMENCER_DATABASE_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/

---

1. POST /auth/register-user

• ป้อนข้อมูล :

  • userID (สตริง): รหัสของผู้ใช้
  • idType (สตริง): ประเภท ID ของผู้ใช้ (สามารถเป็น mobile / email )
  • name (สตริง): ชื่อผู้ใช้

• คอนโทรลเลอร์ :
  ลงทะเบียนผู้ใช้ใหม่และส่ง OTP สำหรับอีเมล/มือถือตามที่กล่าวไว้สำหรับการตรวจสอบ

---

2. POST /auth/login

• ป้อนข้อมูล :

  • userID (สตริง): รหัสของผู้ใช้
  • password (สตริง): รหัสผ่านของผู้ใช้

• คอนโทรลเลอร์ :
  ตรวจสอบสิทธิ์ผู้ใช้และส่งคืนโทเค็นเซสชันเมื่อเข้าสู่ระบบที่ประสบความสำเร็จ

---

3. PUT /auth/reset-password

• ป้อนข้อมูล :
  • otp (หมายเลข): ​​จำเป็นต้องใช้ OTP
  • userID (สตริง): รหัสของผู้ใช้
  • password (สตริง): รหัสผ่านของผู้ใช้
• คอนโทรลเลอร์ :
  รีเซ็ตรหัสผ่านสำหรับผู้ใช้ที่มีอยู่โดยใช้อินพุตที่กล่าวถึง (ใช้วิธี PUT )

---

4. PUT /auth/set-password

• ป้อนข้อมูล :

  • otp (สตริง): จำเป็นต้องใช้ OTP
  • userID (สตริง): รหัสของผู้ใช้
  • password (สตริง): รหัสผ่านของผู้ใช้

• คอนโทรลเลอร์ :
  สร้างรหัสผ่านสำหรับบัญชีของผู้ใช้ (หากไม่เคยตั้งค่ามาก่อน) โดยใช้ OTP ที่ถูกต้อง (ผ่านวิธี PUT )

---

คู่มือการบริจาค

เพื่อมีส่วนร่วมให้สร้างเธรดการสนทนาเพื่อชี้แจงกระบวนการและแนะนำการปรับปรุง

ข้อเสนอแนะและการสนับสนุน

อย่าลังเลที่จะเปิดปัญหาหรือการอภิปรายหากคุณต้องการความช่วยเหลือหรือพบปัญหาใด ๆ การมีส่วนร่วมและข้อเสนอแนะได้รับการสนับสนุนอย่างมากในการปรับปรุงที่เก็บ

---