https://github.com/lucas54neves/rentx
RESTful API for car rental using SOLID and CI/CD concepts
https://github.com/lucas54neves/rentx
api car-rental docker ignite rocketseat sonarcloud typescript
Last synced: about 2 months ago
JSON representation
RESTful API for car rental using SOLID and CI/CD concepts
- Host: GitHub
- URL: https://github.com/lucas54neves/rentx
- Owner: lucas54neves
- License: mit
- Created: 2021-04-12T00:18:42.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-14T01:48:01.000Z (almost 5 years ago)
- Last Synced: 2025-03-02T14:22:36.260Z (over 1 year ago)
- Topics: api, car-rental, docker, ignite, rocketseat, sonarcloud, typescript
- Language: TypeScript
- Homepage:
- Size: 910 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rentX
## Sumário
1. [Informações gerais do projeto](#informacoes-gerais)
2. [Requisitos da aplicação](#requisitos-aplicacao)
2.1. [Cadastro de carros](#cadastro-carros)
2.2. [Listagem de carros](#listagem-carros)
2.3. [Cadastro de especificação para um carro](#cadastro-especificacoes)
2.4. [Cadastro de imagens para um carro](#cadastro-imagens-carro)
2.5. [Aluguel de carro](#aluguel-carro)
2.6. [Devolução de carro](#devolucao-carro)
2.7. [Listagem de aluguéis](#listagem-alugueis)
3. [Comandos principais](#comandos-principais)
3.1. [Virtualização com Docker](#docker)
3.2. [Banco de dados](#database)
## Informações gerais do projeto
A car rental API
#### Requisitos funcionais
- [x] Deve ser possível cadastrar um novo carro.
#### Regras de negócio
- [x] Não deve ser possível cadastrar um carro com uma placa já existente.
- [x] O carro deve ser cadastrado, por padrão, com disponibilidade.
- [x] O usuário responsável pelo cadastro deve ser um usuário administrador.
#### Requisitos funcionais
- [ ] Deve ser possível listar todos os carros disponíveis.
- [ ] Deve ser possível listar todos os carros disponíveis pelo nome da categoria.
- [ ] Deve ser possível listar todos os carros disponíveis pelo nome da marca.
- [ ] Deve ser possível listar todos os carros disponíveis pelo nome do carro.
#### Regras de negócio
- [ ] O usuário não precisa estar logado no sistema.
### Cadastro de especificação para um carro
#### Requisitos funcionais
- [ ] Deve ser possível cadastrar uma especificação para um carro.
#### Regras de negócio
- [ ] Não deve ser possível cadastrar uma especificação para um carro não cadastrado.
- [ ] Não deve ser possível cadastrar uma especificação já existente para o mesmo carro.
- [ ] O usuário responsável pelo cadastro deve ser um usuário administrador.
### Cadastro de imagens para um carro
#### Requisitos funcionais
- [ ] Deve ser possível cadastrar a imagem do carro.
#### Requisitos não-funcionais
- [ ] Deve utilizar o Multer para upload dos arquivos.
#### Regras de negócio
- [ ] O usuário deve poder cadastrar mais de uma imagem para o mesmo carro.
- [ ] O usuário responsável deve ser um usuário administrador.
#### Requisitos funcionais
- [x] Deve ser possível cadastrar um aluguel.
#### Regras de negócio
- [x] O aluguel deve ter duração mínima de 24 horas.
- [x] Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo usuário.
- [x] Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo carro.
- [x] O usuário deve estar logado na aplicação.
- [x] Ao realizar um aluguel, o status do carro deverá ser alterado para indisponível.
#### Requisitos funcionais
- [x] Deve ser possível realizar a devolução de um carro.
#### Regras de negócio
- [x] Se o carro for devolvido com menos de 24 horas, deverá ser cobrado diária completa.
- [x] Ao realizar a devolução, o carro deverá ser liberado para outro aluguel.
- [x] Ao realizar a devolução, o usuário deverá ser liberado para outro aluguel.
- [x] Ao realizar a devolução, deverá ser calculado o total do aluguel.
- [x] Caso o horário de devolução seja superior ao horário previsto de entrega, deverá ser cobrado multa proporcional aos dias de atraso.
- [x] Caso haja multa, deverá ser somado ao total do aluguel.
- [x] O usuário deve estar logado na aplicação.
### Listagem de aluguéis para usuário
#### Requisitos funcionais
- [x] Deve ser possível a busca de todos os aluguéis para o usuário.
#### Regras de negócio
- [x] O usuário deve estar logado na aplicação.
#### Para criar a imagem
```
docker build -t rentx .
```
#### Para executar o container
```
docker run -p 3333:3333 rentx
```
#### Para subir os serviços com o Docker-compose
Os dois comandos anteriores não são necessários caso use o Docker-compose.
```
docker-compose up
```
Para subir os serviços em background:
```
docker-compose up -d
```
#### Criar uma migration
```
yarn typeorm migration:create -n
```
#### Executar as migrations
```
yarn typeorm migration:run
```
#### Reverter migration
```
yarn typeorm migration:revert
```