commencer

Invester ( Q-Auth )

Integração de autenticação fácil para projetos para iniciantes

Visão geral

O Inveners simplifica a integração da autenticação em seus projetos, oferecendo uma configuração rápida e sem complicações.

Seções:

1. Para desenvolvedores usando o pacote / repositório NPM como modelo

Etapa 1: Para instalar o pacote via NPM

 npx commencer

Ou clonar o repositório diretamente

Etapa 2: Configure o seu URL do banco de dados MySQL no arquivo .env em COMMENCER_DATABASE_URL

Etapa 3: gerar arquivos prisma:

 npx prisma generate

Etapa 4: Migrações de implantação:

 npx prisma migrate deploy

---

2. Para colaboradores

As contribuições são bem -vindas!? Siga estas etapas para contribuir:

1. Fork o repositório.

2. Crie uma nova ramificação para o seu recurso ou correção de bug.

3. Palco e compromete suas mudanças:

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

4. Empurre para o seu ramo e crie uma solicitação de tração.

Comandos Git adicionais:

Para encenar mudanças:

 git add <file-path>

Para cometer mudanças:

 git commit # opens vim editor

Para uma mensagem de compromisso simples (não recomendada):

 git commit -m "<message>"

---

3. Processo de registro de usuário

1. Após o registro, os usuários receberão um OTP por e -mail.
2. Os usuários devem verificar o OTP para concluir o registro.
3. O registro não é permitido se o email já estiver no banco de dados, independentemente do status de verificação do OTP.

---

4. Descrição dos pontos de extremidade da API

O arquivo /src/routes/user/index.ts define vários pontos de extremidade relacionados à autenticação. Algumas rotas listadas abaixo são prefixadas com /auth/ .

---

1. POST /auth/register-user

• Entrada :

  • userID (string): o ID do usuário.
  • idType (String): o tipo de ID do usuário (pode ser mobile / email ).
  • name (string): o nome do usuário.

• Controlador :
  Registra um novo usuário e envia um OTP para email/celular, conforme mencionado para verificação.

---

2. POST /auth/login

• Entrada :

  • userID (string): o ID do usuário.
  • password (string): a senha do usuário.

• Controlador :
  Autentica o usuário e retorna um token de sessão no login bem -sucedido.

---

3. PUT /auth/reset-password

• Entrada :
  • otp (número): o OTP necessário.
  • userID (string): o ID do usuário.
  • password (string): a senha do usuário.
• Controlador :
  Redefina a senha para o usuário existente usando as entradas mencionadas (usando o método PUT ).

---

4. PUT /auth/set-password

• Entrada :

  • otp (String): o OTP necessário.
  • userID (string): o ID do usuário.
  • password (string): a senha do usuário.

• Controlador :
  Cria uma senha para a conta do usuário (se eles nunca definiram uma antes) usando um OTP válido (através do método PUT ).

---

Guia de contribuição

Para contribuir, crie um tópico de discussão para esclarecer processos e sugerir melhorias.

Feedback e suporte

Sinta -se à vontade para abrir problemas ou discussões se precisar de assistência ou encontrar algum problema. Contribuições e sugestões são altamente encorajadas a melhorar o repositório.

---