rentX

Sumário

1. Informações gerais do projeto

2. Requisitos da aplicação

   2.1. Cadastro de carros

   2.2. Listagem de carros

   2.3. Cadastro de especificação para um carro

   2.4. Cadastro de imagens para um carro

   2.5. Aluguel de carro

   2.6. Devolução de carro

   2.7. Listagem de aluguéis

3. Comandos principais

   3.1. Virtualização com Docker

   3.2. Banco de dados

Informações gerais do projeto

A car rental API

Requisitos da aplicação

Cadastro de carros

Requisitos funcionais

• Deve ser possível cadastrar um novo carro.

Regras de negócio

• Não deve ser possível cadastrar um carro com uma placa já existente.
• O carro deve ser cadastrado, por padrão, com disponibilidade.
• O usuário responsável pelo cadastro deve ser um usuário administrador.

Listagem de carros

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.

Aluguel de carro

Requisitos funcionais

• Deve ser possível cadastrar um aluguel.

Regras de negócio

• O aluguel deve ter duração mínima de 24 horas.
• Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo usuário.
• Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo carro.
• O usuário deve estar logado na aplicação.
• Ao realizar um aluguel, o status do carro deverá ser alterado para indisponível.

Devolução de carro

Requisitos funcionais

• Deve ser possível realizar a devolução de um carro.

Regras de negócio

• Se o carro for devolvido com menos de 24 horas, deverá ser cobrado diária completa.
• Ao realizar a devolução, o carro deverá ser liberado para outro aluguel.
• Ao realizar a devolução, o usuário deverá ser liberado para outro aluguel.
• Ao realizar a devolução, deverá ser calculado o total do aluguel.
• Caso o horário de devolução seja superior ao horário previsto de entrega, deverá ser cobrado multa proporcional aos dias de atraso.
• Caso haja multa, deverá ser somado ao total do aluguel.
• O usuário deve estar logado na aplicação.

Listagem de aluguéis para usuário

Requisitos funcionais

• Deve ser possível a busca de todos os aluguéis para o usuário.

Regras de negócio

• O usuário deve estar logado na aplicação.

Comandos principais

Virtualização com Docker

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

Banco de dados

Criar uma migration

yarn typeorm migration:create -n <MIGRATION_NAME>

Executar as migrations

yarn typeorm migration:run

Reverter migration

yarn typeorm migration:revert