commencer

시작 ( Q-Auth )

초보자 개발자 프로젝트를위한 쉬운 인증 통합

개요

Commencer는 인증이 프로젝트에 통합되는 것을 단순화하여 빠르고 번거롭지 않은 설정을 제공합니다.

섹션 :

1. NPM 패키지 / 저장소를 템플릿으로 사용하는 개발자의 경우

1 단계 : NPM을 통해 패키지를 설치합니다

 npx commencer

또는 repo를 직접 복제하십시오

2 단계 : COMMENCER_DATABASE_URL 아래 .env 파일에서 mysql 데이터베이스 URL 구성

3 단계 : 프리즘 파일 생성 :

 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 (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 (String) : OTP가 필요합니다.
  • userID (String) : 사용자의 ID.
  • password (문자열) : 사용자의 비밀번호.

• 컨트롤러 :
  유효한 OTP ( PUT 메소드를 통해)를 사용하여 사용자 계정 (이전에 설정 한 적이없는 경우)에 대한 비밀번호를 만듭니다.

---

기여 가이드

기여하려면 프로세스를 명확히하고 개선을 제안하기 위해 토론 스레드를 작성하십시오.

피드백 및 지원

도움이 필요하거나 문제가 발생하면 문제 나 토론을 자유롭게 열어주십시오. 리포지토리를 개선하기 위해 기여와 제안이 적극 권장됩니다.

---