mariyzx/car-shop

Projeto do módulo de back-end do curso de Desenvolvimento Web da Trybe!

🚗 Projeto Car Shop!

Nesse projeto foi desenvolvida uma API para gerenciar uma concessionária de veículos, utilizando o banco de dados MongoDB através do framework Mongoose. Foram aplicados os princípios de Programação Orientada a Objetos (POO).

Desempenho

O projeto Car Shop foi desenvolvido por Mariana Werneck durante o curso de Desenvolvimento Web na Trybe! Foi adquirido 100% do projeto total.

Como utilizar:

Clone o repositório: [email protected]:mariyzx/car-shop.git.

Rodando com Docker 🐳 ou Localmente

👉 Com Docker

⚠ Antes de começar, seu docker-compose precisa estar na versão 1.29 ou superior. Veja aqui ou na documentação como instalá-lo. No primeiro artigo, você pode substituir onde está com 1.26.0 por 1.29.2.

Rode o serviço node com o comando docker-compose up -d --build.

• Esse serviço irá inicializar um container chamado car_shop e outro chamado car_shop_db.
• A partir daqui você pode rodar o container via CLI ou abri-lo no VS Code.

ℹ️ Use o comando docker exec -it car_shop bash.

• Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.

ℹ️ Instale as dependências [Caso existam] com npm install

• ⚠ Atenção: Caso opte por utilizar o Docker, TODOS os comandos disponíveis no package.json (npm start, npm test, npm run dev, ...) devem ser executados DENTRO do container, ou seja, no terminal que aparece após a execução do comando docker exec citado acima.

👉 Sem Docker

ℹ️ Instale as dependências [Caso existam] com npm install

• ✨ Dica: Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.
• ✨ Dica: O projeto espera que a versão do node utilizada seja a 16.

Rotas:

O projeto está rodando na porta 3001, ao acessar o endpoint /docs irá encontrar a documentação de rotas da API!

Tecnologias utilizadas:

• Typescript
• MongoDB
• Mongoose
• NodeJS
• Docker
• Mocha
• Chai
• Sinon
• POO
• Swagger

Connect: