commencer

Начальный ( Q-Auth )

Легкая интеграция аутентификации для начинающих проектов DEV

Обзор

Начало упрощает интеграцию аутентификации в ваши проекты, предлагая быструю и беспроблемную настройку.

Разделы:

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/ .

---

1. POST /auth/register-user

• Вход :

  • userID (строка): идентификатор пользователя.
  • idType (String): тип идентификатора пользователя (может быть 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 (String): OTP требуется.
  • userID (строка): идентификатор пользователя.
  • password (строка): пароль пользователя.

• Контроллер :
  Создает пароль для учетной записи пользователя (если он никогда не устанавливал его раньше), используя действительный OTP (с помощью метода PUT ).

---

Руководство по взносу

Чтобы внести свой вклад, создайте обсуждение потока для уточнения процессов и предложить улучшения.

Обратная связь и поддержка

Не стесняйтесь открывать вопросы или обсуждения, если вам нужна помощь или столкнуться с какими -либо проблемами. Вклады и предложения очень рекомендуются улучшить хранилище.

---