Challenge Backend

API que permite revendedores consultar seus benefícios de acordo com seu volume de vendas

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

🚀 Tecnologias

Esse projeto foi desenvolvido com base no desafio proposto pelo time do Grupo Boticário com as seguintes tecnologias:

• Nodejs
• Typescript
• Restify
• Restify Errors
• MongoDB
• Mongoosejs
• jsonwebtoken
• Axios
• Supertest
• Jest
• Heroku
• VS Code com ESLint

💻 Instalação

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

# Acesse o repositorio
$ cd resellers-boticario

# Instale as dependências
$ npm install

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

# Executar os testes
$ npm test

📙 Documentação

A documentação da API está disponível aqui e também dentro do diretório /collections. Esta documentação foi criada utilizando a ferramenta Postman. Para visualiza-lá em sua máquina local, primeiramente faça o download do aplicativo. Na sequência, abra a ferramenta e no canto superior esquerdo clique com o botão na Aba (Import > Depois arraste o arquivo resellers-boticario.postman_collection para dentro do quadro e Clique em OK)

Algumas rotas são protegidas e necessitam de um token para acesso. Para gerar um token válido, acesse a rota /resellers/auth e insira um email e senha cadastrado na base. Se não houver nenhum usuário, cadastre manualmente. Há um exemplo na própria documentação.

📝 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!