Eat Eating API

Este repositório está vinculado ao projeto da API do sistema Eat Eating

API Eat-Eating

API construída em NodeJS e ExpressJS utilizando TDD para garantir a qualidade do código. A API permite o controle de acesso de usuários, com funcionalidades de cadastro, exclusão, atualização e busca de usuários.

Aviso

Cada alteração deve ser documentada, a exemplo das rotas, com detalhes sobre os parâmetros esperados e o formato de retorno. Variaveis de ambientee pacotes novos adicionados e possiveis problemas futuros sobre debugar o projeto e etc.

Tecnologias utilizadas

• NodeJS: Versão 20.9

• ExpressJS: Versão 4.18

• SequelizeJS: Versão 6.35

• postgresSQL: Versão 15

• Typescript: Versão 5.3

Crie um banco de dados para a aplicação

1. Acesse o PostgreSQL:

Abra o terminal ou prompt de comando e acesse o PostgreSQL usando o utilitário psql. Você pode fazer isso usando o seguinte comando:

      psql -U SEU_USUARIO

Substitua SEU_USUARIO pelo seu nome de usuário do PostgreSQL.

2. Crie um Banco de Dados:

Dentro do ambiente do PostgreSQL, crie um novo banco de dados com o seguinte comando:

      CREATE DATABASE NOME_DO_BANCO;

😊 Seu banco foi criado, agora pode usar a URL nas descrições abaixo:

IMPORTANTE:

É necessário ter pelo menos a versão estável mais recente do Node e NPM. Certifique-se de tê-los instalados corretamente para instalar as dependências necessárias e executar o projeto.

Na pasta "eat-eating-api", crie um arquivo chamado: .env com o seguinte formato:

# database
DATABASE_URL = 'DIALECT://DB_USER:DB_PASSWORD@DB_HOST:DB_PORT/DB_NAME'

Por exemplo:
DATABASE_URL = 'postgres://labsif:1234@localhost:5432/eateating'


# tokens
ACCESS_LOCAL_KEY_TOKEN = 'chave do tipo hash md5'
ACCESS_LOCAL_KEY_TOKEN_REFRESH = 'chave do tipo hash md5'

Para obter as chaves acima  entre no link: https://passwordsgenerator.net/md5-hash-generator/
Digite palavras aleatórias para obter a chave (a chave das variáveis devem ser diferentes).


# localhost


#credenciais para autentição
ACCESS_LOCAL_KEY_TOKEN_REFRESH = 123456
ACCESS_LOCAL_KEY_TOKEN = 4567890
PORT = numero da porta de preferencia

#nodemailer credenciais para envio de email
USER_EMAIL = 35e9b6df75846
PASSWORD_EMAIL = a3f84dce442daf
HOST = sandbox.smtp.mailtrap.io #transportador de email
NODEMAILER_EMAIL = exemplo@gmail.com
SMTP_PORT = 587 (PRECISA SER OBRIGATORIAMENTE 587)

LINK = localhost:3001 # link do front end onde sera usado no email para redirecionar para a pagina de redefinição de senha

Rotas da aplicação

• /users/createrota post recebe um email, um password e um emailRecovery e retorna um usuario criado no banco de dados

• users/auth rota post recebe um email, um password e retorna um objeto com o token um refresh token com seu tempo de inspiração e o usuario autenticado

• users/refresh rota post recebe um refresh token e retorna o refresh token e seu tempo de expiração

• users/updatePassword recebe uma senha e token para resetar senha, altera a senha do usuario com o token retorna o usuario com a senha alterada.

• users/forgotPassword recebe um email de usuario envia um email para usuario que quer trocar a senha com o token para trocar a senha e retorna uma mensagem de sucesso da operação

testar envio de e-mails

• Para testar a rota forgotPassword é necessario ter um transportador de emails de teste para isso vá no site mailtrap, crie uma conta, vá na parte de email testing e troque a seleção de tecnolgia para node pegue as credenciais do site como host, usuario e senha e cole em seu .env na parte de nodemailer credentials como a forma descrita acima, quando enviar o email será enviado para esse site.

Crie um banco de dados com o nome "eateating" usando o PostgreSQL.

Instalação

1. Clone este repositório
2. Na raiz do projeto, instale as dependências: npm install
3. Inicie a aplicação em desenvolvimento: npm run dev
4. Gere o buld da aplicação com: npm run build
5. Inicie a aplicação build: npm run start