BrunoPelegrino / car-shop

O objetivo do projeto foi desenvolver uma aplicação back end para a construção de uma API RESTful de gerenciamento uma concessionária de veículos.

Project Car Shop

Projeto desenvolvido no módulo de Back-end da Trybe.

✏ Sobre o projeto

O objetivo do projeto foi desenvolver uma aplicação back end para a construção de uma API RESTful de gerenciamento uma concessionária de veículos.
A aplicação foi desenvolvida em Node.js aplicando os princípios de Programação Orientada a Objetos (POO) e utilizando o banco de dados MongoDB através do framework mongoose (ODM) para realizar o CRUD.

Principais tecnologias utilizadas:

• POO;
• Node.js;
• Express.js;
• mongoDB;
• Mongoose(ODM);
• Docker;
• JavaScript;

⚙ Como rodar o projeto na sua máquina

1. Faça o git clone na sua máquina e entre no diretório:

• Lembre-se de clonar o repositório no diretório desejado na sua máquina!

git clone https://github.com/BrunoPelegrino/car-shop

2. Escolha por onde rodar a aplicação: Docker vs Local

🐳 Rodando no Docker

**:warning: Seu docker-compose precisa estar na versão 1.29 ou superior. [Veja aqui](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04-pt) ou [na documentação](https://docs.docker.com/compose/install/) como instalá-lo. No primeiro artigo, você pode substituir onde está com `1.26.0` por `1.29.2`.** 👉 2.1 Rode os serviços `node` e `db` com o comando: ``` docker-compose up -d --build ``` ⚠️ Lembre-se de parar qualquer aplicação que estiver usando localmente na porta padrão (`3306`), seja docker ou mySQL, 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 no VS Code; 👉 2.2 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. 👉 2.3 Instale as dependências dentro do container com: ``` npm install npm run debug ```

• ⚠️ 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.
• ✨ Dica: A extensão Remote - Containers (que estará na seção de extensões recomendadas do VS Code) é indicada para que você possa desenvolver sua aplicação no container Docker direto no VS Code, como você faz com seus arquivos locais.

💻 Localmente

👉 2.1 Instale as dependências: ``` npm install ``` - **:warning: Atenção:** Não esqueça de renomear/configurar o arquivo `.env.example` para os testes locais funcionarem. - **:warning: Atenção:** Para rodar o projeto desta forma, **obrigatoriamente** você deve ter o `Node.js` instalado em seu computador. - **:warning: Atenção:** A versão do `Node.js` e `NPM` a ser utilizada é `"node": ">=16.0.0"` e `"npm": ">=7.0.0"`, como descrito a chave `engines` no arquivo `package.json`. Idealmente deve-se utilizar o Node.js na `versão 16.14`, a versão na que esse projeto foi testado.

---

© Desenvolvido por Bruno Pelegrino