Desafio-CompassMart 🏬

Repositório criado para o Desafio Técnico Final - Compass UolCompassStore-Challenge.

Status do Projeto: Em desenvolvimento ⚙️

Tópicos::writing_hand:

🔹 Descrição do projeto

🔹 Funcionalidades

🔹 Pré-requisitos/Dependências

🔹 Como rodar a aplicação

🔹 Swagger e Documentação

🔹 Developer

Descrição do projeto::memo:

Projeto desenvolvido para o programa de bolsas Compass Uol. O projeto tem a seguinte descrição:

"A compasso entrou em um novo ramo de mercado, a CompassMart a qual é uma loja de departamento, onde seu foco é a comercialização de alimentos. Para essa API vai ser necessário desenvolver algumas rotas."

Funcionalidades::wrench:

Funcionalidades para Produto:

✔️Criação de um novo produto.

​ ➖ Request - POST -http://localhost:3000/api/v1/product

✔️Listar todos os produtos cadastrados.

​ :heavy_minus_sign: Request - GET - http://localhost:3000/api/v1/product

✔️Buscar por X produto cadastrado.

​ :heavy_minus_sign: Request - GET - http://localhost:3000/api/v1/product/:id

✔️Atualizar X produto cadastrado.

​ :heavy_minus_sign: Request - PUT - http://localhost:3000/api/v1/product/:id

✔️Atualizar X produto cadastrado.

​ :heavy_minus_sign: Request - PATCH - http://localhost:3000/api/v1/product/:id

✔️Deletar X produto cadastrado.

​ :heavy_minus_sign: Request - DELETE - http://localhost:3000/api/v1/product/:id

✔️Deve ser possível listar todos os produtos que estão com o estoque baixo.

​ :heavy_minus_sign: Request - GET - http://localhost:3000/api/v1/product/low_stock

✔️Criação de novos produtos através de um CSV

​ :heavy_minus_sign: Request - POST - http://localhost:3000/api/v1/product/csv

✔️Retorno de um produto através de um mapper

➖ Request - GET - http://localhost:3000/api/v1/product/marketplace

Funcionalidades de Usuário:

✔️Listar todos os usuários.

➖ Request - GET -http://localhost:3000/api/v1/user

✔️Criação de um novo usuário.

➖ Request - POST -http://localhost:3000/api/v1/user

✔️Login de usuário.

➖ Request - POST -http://localhost:3000/api/v1/User/authenticate

Pré-requisitos/Dependências:books:

📗 Cors

📗 Dotenv

📗 Eslint

📗 Express

📗 Faker

📗 Jest

📗 Joi

📗 MongoDb

📗 Mongoose

📗 Mongoose-paginate-v2

📗 Multer

📗 Nodejs

📗 Nodemon

📗 Prettier

📗 SuperTest

📗 Typescript

Como rodar a aplicação::arrow_forward:

1️⃣ Clone o repositório no github: https://github.com/fabiotbraga/Desafio-CompassMart.git.

2️⃣ Instale as dependências: npm install.

3️⃣ Crie um arquivo .env baseado no arquivo .env.example. contido no repositório. O arquivo deve conter as informações do seu banco de dados mongoDb. Caso não possua cria um em: https://www.mongodb.com/pt-br

4️⃣ Rode o código no terminal: npm run dev.

Como rodar os testes::hammer_and_wrench:

1️⃣ Crie um arquivo .env.test baseado no arquivo .env.example. contido no repositório. O arquivo deve conter as informações do seu banco de dados mongoDb. Caso não possua cria um em: https://www.mongodb.com/pt-br. Esse banco deve ser diferente do que está a aplicação e deve ser usado para os testes.

4️⃣ Rode o código no terminal: npm run test.

Swagger e Documentação: 📖

🖊️ Documentação Swagger disponível em rota e pode ser aberta no navegador com o seguinte entereço:

🖊️ http://localhost:3000/api/v1/api-docs

Deploy no Heroku:

• https://compassmartdeploy.herokuapp.com/

Developer::man_technologist:

Fábio Teixeira