commencer

CMENCERS （ 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/が付いています。

---

1。post POST /auth/register-user

• 入力：

  • userID （string）：ユーザーのID。
  • idType （string）：ユーザーのIDタイプ（ mobile / emailにすることができます）。
  • name （文字列）：ユーザーの名前。

• コントローラー：
  新しいユーザーを登録し、検証のために述べたように、電子メール/モバイルにOTPを送信します。

---

2。 POST /auth/login

• 入力：

  • userID （string）：ユーザーのID。
  • password （文字列）：ユーザーのパスワード。

• コントローラー：
  ユーザーを認証し、成功したログインでセッショントークンを返します。

---

3. PUT /auth/reset-password

• 入力：
  • otp （番号）：OTPが必要です。
  • userID （string）：ユーザーのID。
  • password （文字列）：ユーザーのパスワード。
• コントローラー：
  上記の入力を使用して既存のユーザーのパスワードをリセットします（ PUTメソッドを使用）。

---

4. PUT /auth/set-password

• 入力：

  • otp （文字列）：OTPが必要です。
  • userID （string）：ユーザーのID。
  • password （文字列）：ユーザーのパスワード。

• コントローラー：
  有効なOTP（ PUTメソッドを介して）を使用して、ユーザーのアカウントのパスワード（以前に設定したことがない場合）のパスワードを作成します。

---

貢献ガイド

貢献するには、プロセスを明確にし、改善を提案するためのディスカッションスレッドを作成します。

フィードバックとサポート

支援が必要な場合や問題が発生した場合は、問題や議論を自由に開きます。貢献と提案は、リポジトリを改善するために強く奨励されています。

---