README.md

Desafio Backend Software Engineer

API desenvolvida como desafio técnico para a vaga de Backend Software Engineer

Technologias   |    Instalação   |    Documentação da API   |    Licença

Tecnologias

Esse projeto foi desenvolvido utilizando as seguintes tecnologias:

• Nodejs
• Typescript
• Fastify
• Postgres
• Knex
• Heroku

💻 Instalação

Pré-requisitos

1. Instale o nvm
2. Instale o docker
3. Instale o yarn

🔥 Rodando o projeto

# Faça o clone do repositório
$ git clone https://github.com/diegolemospadilha/receivers-api.git 

# Acesse o repositório
$ cd receivers-api

# Crie o arquivo com as variáveis de ambiente necessárias para o projeto
$ cp .env.example .env

# Crie o arquivo com as variáveis de ambiente para o projeto
$ nvm install

# Instale as dependências
$ yarn install

# Inicialize o banco de dados com docker
$ docker-compose up -d postgres

# Rodar migrations do banco de dados
$ yarn run knex:migrate:latest

# Rode o projeto
# Obs: Para que este comando funcione corretamente é necessário ter o postgres instalado e inicializado
$ yarn dev

# Rode todos os testes da aplicação
# Obs: Para que este comando funcione corretamente é necessário ter o postgres instalado e inicializado e a aplicação rodando
$ yarn test

# Rode somente os testes unitários
$ yarn test:unit

# Rode somente os testes de integração
# Obs: Para que este comando funcione corretamente é necessário ter o postgres instalado e inicializado e a aplicação rodando
$ yarn test:integration

📙 Documentação

• API Reference - Swagger
• Collection Postman - com exemplos de requisições

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito ♥ by Diego Lemos Padilha 👋 Entre em contato!