Dindin

Seja bem vindo(a)!

---

Como Usar

1. Clone o Repositório

   • Clone este repositório para o seu computador usando o seguinte comando:

     $ git clone git@github.com:novvais/dindin.git

2. Encontre o Diretorio

   • Encontre o diretorio usando o código abaixo:

     $ cd didin

3. Baixe todas as Dependecias do Projeto

   • No terminal utilize o código abaixo para baixar todas as bibliotecas:

     $ npm i

4. Inicie o Servidor

   • Inicie o servidor usando o código:

     $ npm run dev

5. Para executar as rotas utilize o Insomnia ou um programa similiar

   • Baixe e instale o Insomnia acessando o link: https://insomnia.rest/download
   • Crie uma conta e se conecte no aplicativo

6. Para gerenciar o Database utilize o Beekeeper Studio

   • Baixe e instale o Beekeeper acessando o link: https://www.beekeeperstudio.io/get

Como Usar o Insomnia

Passo a Passo

1. Na página incial do Insomnia, clique no ícone de + no canto superior direito:

   

2. Clique na primeira opção:

   

3. Dê um nome para a coleção:

   

4. Clique no ícone de + para criar uma rota:

   

5. Clique na primeira opção:

   

6. Escolha o verbo da rota

   • Adicione o domínio e o caminho da API:

     http://localhost:3000

   

Como Testar as Rotas

Funções do Insomnia

Body

• Para usar o Body:
  • Clique na caixa com o nome "Body" em seguida clique na opção "JSON" como mostra a imagem abaixo:
    

Bearer Token

• Para usar o Bearer:
  • Clique na caixa com o nome "Auth":
    
  • Em seguida clique na opção "Bearer Token"
    
  • Adicione o Token gerado na rota "login" como mostra a imagem abaixo:
    

Explicando as Rotas

Para o código funcionar você precisa adicionar uma senha entre '' da sua escolha no .env

1. Rota POST "cadastroUsuario" - Obrigatório o uso do body request

   • Adicione o dominio e o caminho da API:

     http://localhost:3000/usuario

   
   • Exemplo de resposta:
   

2. Rota POST "login" Obrigatório o uso do body request

   • Adicione o dominio e o caminho da API:

     http://localhost:3000/login

   • Adicione os dados do usuário no body:

   
   • Exemplo de resposta:
   

   Importante: Use o Token gerado na resposta para realizar os demais testes de rota!

3. Rota GET "detalharUsuario" - Obrigatório o uso do Bearer Token

   • Adicione o dominio e o caminho da API.

     http://localhost:3000/usuario

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   
   

4. Rota PUT "atualizarUsuario" - Obrigatório o uso do Bearer Token

   • Adicione o dominio e o caminho da API

     http://localhost:3000/usuario

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   

5. Rota GET "listarCategorias" - Obrigatório o uso do Bearer Token

   • Adicione o dominio e o caminho da API

     http://localhost:3000/categorias

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   
   

6. Rota GET "listarTransacoesDoUsuario" - Obrigatório o uso do Bearer Token

   • Adicione o dominio e o caminho da API

     http://localhost:3000/transacao

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   
   

7. Rota GET "detalharTransacao" Obrigatório o uso do Bearer Token e Params

   • Adicione o dominio e o caminho da API

     http://localhost:3000/transacao/1

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   
   • Adicione o id do usuário após a "/" da URL básica.
   

8. Rota POST "cadastrarTransacao" - Obrigatório o uso do Bearer Token e Body

   • Adicione o dominio e o caminho da API

     http://localhost:3000/transacao

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   
   • Adicione as informações da transação para cadastrar no Body.
   

9. Rota PUT "atualizarTransacao" - Obrigatório o uso do Bearer Token, Params e Body

   • Adicione o dominio e o caminho da API

     http://localhost:3000/transacao/1

   • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

   

   • Adicione o id do usuário após a "/" da URL básica.

   • Adicione as informações da transação para atualizar no Body.

   

10. Rota DELETE "excluirTransacao" - Obrigatório o uso do Bearer Token e Params

    • Adicione o dominio e o caminho da API

      http://localhost:3000/transacao/1

    • Adicione o Token gerado na resposta da rota "login" para continuar o teste.

    
    • Adicione o id do usuário que vai ser excluído após a "/" da URL básica.
    

11. Rota GET "obterExtrato" - Obrigatório o uso do Bearer Token e Params

• Adicione o dominio e o caminho da API

  http://localhost:3000/transacao/extrato

• Adicione o Token gerado na resposta da rota "login" para continuar o teste.

Database

PostgreSQL

Para poder usar o Database você precisa baixar e instalar o PostgreSQL, foi o gerenciador de Database utilizado no código.

1. Baixe e instale o PostgreSQL

   • Acesse o link e baixe a última versão disponível: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

2. Execute o arquivo baixado

3. Em seguida vai ser aberta uma aba para a instalação, clique em "Next"

4. Escolha onde vai ser instalado o Postgre e em seguida clique em "Next"

5. Selecione somente a primeira e a última opção e em seguida clique em "Next"

6. Escolha a paste onde vai ser armazenado o Database e em seguida clique em "Next"

7. Cria um senha para acessar o Database

   • Essa senha será usada para acessar o Beekeeper, grave essa senha
   • O usuário para acessar será o padrão "postgres"
   • Em seguida clique em "Next"
   

8. A porta usada será a padrão então somente clique em "Next"

9. Escolha a lingua

10. Agora basta clicar em "Next" até finalizar a instalação.

Como usar o Beekeeper

1. Após a instalação abra o Beekeeper para iniciar

2. Escolha o Database que vai ser usado, nesse caso vai ser o "PostgreSQL"

3. Insira seu nome de usuário e a senha criada na instalação do "PostgreSQL" e clique em "Connect"

   • O nome de usuário vai ser o padrão "postgres"
   

• Para criar o Database utilize o código que está no arquivo dump.sql
  • Copie e cole o código na aba query do Beekeeper, execute cada bloco individualmente
  

Está quase pronto, agora basta conectar a API com o Database usando o dotenv.

Conectando a API com o Database

1. Crie um arquivo chamado .env e use as informações do arquivo .env.example

2. Adicione do Beekeeper no .env <img src="./src/assets/connect.env.png/>

• Exemplo
  • Em DB_DATABASE você tem que inserir o nome do database criado no Beekeeper que no caso se chama "dindin"
  

---

Exemplo de conteúdo do Body Request:

• Código:

  {
      "nome": "Foo Ba",
      "email": "foo@bar.com",
      "cpf": "00011122233",
      "data_nascimento": "15/03/2001",
      "telefone": "11999998888",
      "senha": "1234"
  }   

Exemplo de saída: