🚗 Aluguel de Carros

Aplicação de aluguel de carros feita com NodeJs. Onde, é possível cadastrar um usuário, cadastrar um carro e suas especificações e cadastrar um aluguel. Esta API foi desenvolvida seguindo o padrão de arquitetura limpa SOLID, da Programação Orientada a Objetos.

---

⚙️ Tecnologias utilizadas:

Segue abaixo as principais dependências utilizadas nesta API:

• Express;
• TypeScript;
• TypeORM.

Outras dependências utilizadas no desenvolvimento:

• Uuid;
• Multer;
• Csv-Parse.

Também, foram utilizadas as seguintes ferramentas para manter o código limpo e padronizado:

• Prettier;
• ESLint;
• EditorConfig for VS Code.

Para a documentação foi utilizado o Swagger.

Para os containers foi utilizado o Docker.

---

📁 Como executar o projeto:

🚀 Com Yarn:

• Instale o NodeJs

• Instale o Yarn

• Execute os comandos abaixo no terminal:

  #Clona o repositório
  $ git clone https://github.com/zoccalucas/car-api.git

  #Acessa o diretório do projeto
  $ cd car-api

  #Instala as dependências
  $ yarn install

  #Cria as tabelas do banco de dados
  $ yarn typeorm migration:run

  #Executa a aplicação
  $ yarn dev

💻 Com NPM:

• Instale o NodeJs

• Execute os comandos abaixo no terminal:

  #Clona o repositório
  $ git clone https://github.com/zoccalucas/car-api.git

  #Acessa o diretório do projeto
  $ cd car-api

  #Instala as dependências
  $ npm install

  #Cria as tabelas do banco de dados
  $ npm run typeorm migration:run

  #Executa a aplicação
  $ npm run dev

• A API está rodando na porta 3333

• Visualize a documentação na rota http://localhost:3333/api-docs

---

🛠️ API em desenvolvimento 🛠️