API em Node.js para aluguel de carros

Sobre | Tecnologias | Executando | Licença

---

Sobre o projeto

RentX é uma API REST desenvolvida em um bootcamp de back-end chamado Ignite. É uma plataforma de aluguel de carros que permite gerir os seus veículos, as suas características e, claro, os seus aluguéis!

Tecnologias utilizadas

• Typescript - Superset para JavaScript
• Nodejs
• Multer - Middleware de upload de arquivos
• Expressjs - Micro framework web
• Swagger UI - Design e documentção da API

Como executar

Use o seu terminal para clonar o repositório para a sua maquina local

$ git clone https://github.com/alisson-moura/RENTX.git
$ cd RENTX
$ npm install

Banco de dados

As configurações do banco de dados estão em ormconfig.json, para utilizar, um banco de dados é necessário preencher o arquivo .env de acordo com o seu ambiente

Alguns comandos da app

$ npm run typeorm migration:run # executa as migrations no banco de dados
$ npm run seed:admin # insere um seed no banco de dados do usuário administrador
$ npm run test # executa os testes automatizados de integração e unidade
$ npm run dev # inicia a aplicação em modo de desenvolvimento 

Documentação

Os endpoints da API estão documentados com a interface do Swagger. Para acessar a documentação, basta iniciara a aplicação e acessar no seu navegador

http://localhost:3333/api-docs

Licença

Este projeto está sob a licença do MIT. Leia o arquivo LICENSE para mais informações.

---

Feito com ❤️ por Alisson Moura