antunesgean / car-shop

Boas-vindas ao repositório do Projeto Car Shopping

Para abrir o projeto, atente-se as orientações descritas a seguir, e, caso tenha qualquer dúvida, entre em contato.

👨‍💻 Projeto Car Shopping

Para este projeto, foram aplicados os princípios de Programação Orientada a Objetos (POO) para a construção de uma API com CRUD para gerenciar uma concessionária de veículos. Isso foi feito utilizando o banco de dados MongoDB através do framework do Mongoose.

Orientações

⚠ Como iniciar o projeto

1. Clone o repositório

• Use o comando: git clone [email protected]:AntunesGean/car-shop.git.

• Entre na pasta do repositório que você acabou de clonar:

• cd car-shop

2. Instale as dependências

• npm install

3. E está pronto para usar e testar!

🐳 Rodando no Docker vs Localmente

👉 Com Docker

⚠ Antes de começar, o 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 os serviços node e db com o comando docker-compose up -d.

• Lembre-se de parar o mongo se estiver usando localmente na porta padrão (27017), ou adapte, caso queria fazer uso da aplicação em containers

• Esses serviços irão inicializar um container chamado car_shop e outro chamado car_shop_db.

• A partir daqui você pode rodar o container car_shop via CLI ou abri-lo na IDE.

ℹ️ 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 rodar utilizando 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.

• ⚠ Atenção: O git dentro do container não vem configurado com credenciais. Ou faça os commits fora do container, ou configure as credenciais do git dentro do container.

• ✨ Dica: A extensão Remote - Containers é indicada para que você possa acessar sua aplicação no container Docker direto no VS Code, assim como é feito com os arquivos locais.

👉 Sem Docker

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

⚠ Atenção: Não rode o comando npm audit fix! Ele atualiza várias dependências do projeto, e essa atualização gera conflitos com o avaliador.

• ✨ Dica: Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.