smookeydev / letsgo-api Goto Github PK

• Sobre
• Requisitos para rodar o projeto
• Instalação
• Rotas da API
• Observações

Projeto desenvolvido como parte de um processo seletivo da empresa Let's. Nesse projeto foi desenvolvido uma API usando Express, onde tem a função de criar um JWT com o endpoint /api/createtoken e adicionar um contato com o endpoint /api/insertcontact.

• Node.Js
• Yarn
• Docker
• Docker Compose

1.Instale o Docker seguindo o tutorial a seguir: https://docs.docker.com/engine/install/ubuntu/

2.Instale o Docker Compose seguindo o tutorial a seguir: https://docs.docker.com/compose/install/

3.Clone este repositório usando o seguinte comando:

$ git clone [email protected]:smookeydev/letsgo-api.git

4.Acesse a pasta do projeto em seu terminal:

$ cd letsgo-api

5.Rode o comando de instalação das bibliotecas utilizada no projeto.

$ yarn

6.Copie o arquivo de configuração de exemplo para um arquivo de configuração real:

$ cp .env.example .env

7.Troque os valores existentes no arquivo de configuração, os valores são:

• SECRET_KEY: Chave secreta a ser utilizada o JWT. (Obrigátorio)
• DB_HOST: Endereço IPV4 a ser utilizado para conexão do banco de dados. (Opcional)
• DB_PORT: Porta que será usada para o banco de dados. (Opcional)
• DB_NAME: Nome do banco de dados. (Opcional)
• DB_USER: Usuário do banco de dados. (Obrigatório)
• DB_PASS: Senha do usuário do banco de dados. (Obrigatório)

8.Inicie o banco de dados rodando o seguinte comando:

$ make up

9.Inicie a API rodando o seguinte comando:

$ yarn dev

• Nesse repositorio existe um arquivo chamado letsgo-api.json, que é um documento exportado do Insomnia com as rotas da API e dados de exemplo.