commencer

Commencer ( Q-auth )

Integrasi Otentikasi Mudah untuk Proyek Dev Pemula

Ringkasan

Commencer menyederhanakan integrasi otentikasi ke dalam proyek Anda, menawarkan pengaturan cepat dan bebas repot.

Bagian:

1. Untuk pengembang yang menggunakan paket / repositori NPM sebagai template

Langkah 1: Untuk menginstal paket melalui NPM

 npx commencer

Atau mengkloning repo secara langsung

Langkah 2: Konfigurasikan URL Database MySQL Anda di file .env di bawah COMMENCER_DATABASE_URL

Langkah 3: Hasilkan file prisma:

 npx prisma generate

Langkah 4: Menyebarkan migrasi:

 npx prisma migrate deploy

---

2. Untuk kontributor

Kontribusi dipersilakan!? Ikuti langkah -langkah ini untuk berkontribusi:

1. Garpu repositori.

2. Buat cabang baru untuk fitur atau perbaikan bug Anda.

3. Panggung dan melakukan perubahan Anda:

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

4. Dorong ke cabang Anda dan buat permintaan tarik.

Perintah git tambahan:

Untuk perubahan panggung:

 git add <file-path>

Untuk melakukan perubahan:

 git commit # opens vim editor

Untuk pesan komit sederhana (tidak disarankan):

 git commit -m "<message>"

---

3. Proses Pendaftaran Pengguna

1. Setelah pendaftaran, pengguna akan menerima OTP melalui email.
2. Pengguna harus memverifikasi OTP untuk menyelesaikan pendaftaran.
3. Pendaftaran ulang tidak diizinkan jika email sudah ada dalam database, terlepas dari status verifikasi OTP.

---

4. Deskripsi titik akhir API

File /src/routes/user/index.ts mendefinisikan beberapa titik akhir yang terkait dengan otentikasi. Beberapa rute yang tercantum di bawah ini diawali dengan /auth/ .

---

1. POST /auth/register-user

• Input :

  • userID (string): ID pengguna.
  • idType (String): Jenis ID Pengguna (dapat berupa mobile / email ).
  • name (String): Nama pengguna.

• Pengontrol :
  Mendaftarkan pengguna baru dan mengirim OTP untuk email/seluler sebagaimana disebutkan untuk verifikasi.

---

2. POST /auth/login

• Input :

  • userID (string): ID pengguna.
  • password (String): Kata sandi pengguna.

• Pengontrol :
  Mengotentikasi pengguna dan mengembalikan token sesi pada login yang berhasil.

---

3. PUT /auth/reset-password

• Input :
  • otp (Nomor): OTP diperlukan.
  • userID (string): ID pengguna.
  • password (String): Kata sandi pengguna.
• Pengontrol :
  Mengatur ulang kata sandi untuk pengguna yang ada menggunakan input yang disebutkan (menggunakan metode PUT ).

---

4. PUT /auth/set-password

• Input :

  • otp (String): OTP diperlukan.
  • userID (string): ID pengguna.
  • password (String): Kata sandi pengguna.

• Pengontrol :
  Membuat kata sandi untuk akun pengguna (jika belum pernah mengaturnya sebelumnya) menggunakan OTP yang valid (melalui metode PUT ).

---

Panduan Kontribusi

Untuk berkontribusi, buat utas diskusi untuk mengklarifikasi proses dan menyarankan perbaikan.

Umpan balik dan dukungan

Jangan ragu untuk membuka masalah atau diskusi jika Anda memerlukan bantuan atau menghadapi masalah. Kontribusi dan saran sangat dianjurkan untuk meningkatkan repositori.

---