commencer

Commencer ( Q-Auth )

تكامل المصادقة السهل لمشاريع ديف المبتدئين

ملخص

يقوم Commencer بتبسيط تكامل المصادقة في مشاريعك ، ويقدم إعدادًا سريعًا وخاليًا من المتاعب.

الأقسام:

1. للمطورين الذين يستخدمون حزمة / مستودع NPM كقالب

الخطوة 1: لتثبيت الحزمة عبر NPM

 npx commencer

أو استنساخ الريبو مباشرة

الخطوة 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/ .

---

POST /auth/register-user

• مدخل :

  • userID (سلسلة): معرف المستخدم.
  • idType (سلسلة): نوع معرف المستخدم (يمكن أن يكون 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 ).

---

دليل المساهمة

للمساهمة ، قم بإنشاء مؤشر ترابط مناقشة لتوضيح العمليات واقتراح التحسينات.

ردود الفعل والدعم

لا تتردد في فتح القضايا أو المناقشات إذا كنت بحاجة إلى مساعدة أو مواجهة أي مشاكل. يتم تشجيع المساهمات والاقتراحات بشدة على تحسين المستودع.

---