{"id":20084195,"url":"https://github.com/lucas54neves/rentx","last_synced_at":"2026-05-06T13:34:24.448Z","repository":{"id":48697187,"uuid":"357010297","full_name":"lucas54neves/rentX","owner":"lucas54neves","description":"RESTful API for car rental using SOLID and CI/CD concepts","archived":false,"fork":false,"pushed_at":"2021-07-14T01:48:01.000Z","size":932,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-02T14:22:36.260Z","etag":null,"topics":["api","car-rental","docker","ignite","rocketseat","sonarcloud","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lucas54neves.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-12T00:18:42.000Z","updated_at":"2021-10-14T20:56:30.000Z","dependencies_parsed_at":"2022-08-26T08:30:57.560Z","dependency_job_id":null,"html_url":"https://github.com/lucas54neves/rentX","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lucas54neves/rentX","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucas54neves%2FrentX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucas54neves%2FrentX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucas54neves%2FrentX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucas54neves%2FrentX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucas54neves","download_url":"https://codeload.github.com/lucas54neves/rentX/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucas54neves%2FrentX/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265498000,"owners_count":23777093,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","car-rental","docker","ignite","rocketseat","sonarcloud","typescript"],"created_at":"2024-11-13T15:51:04.014Z","updated_at":"2026-05-06T13:34:24.364Z","avatar_url":"https://github.com/lucas54neves.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rentX\n\n## Sumário\n\n1. [Informações gerais do projeto](#informacoes-gerais)\n\n2. [Requisitos da aplicação](#requisitos-aplicacao)\n\n   2.1. [Cadastro de carros](#cadastro-carros)\n\n   2.2. [Listagem de carros](#listagem-carros)\n\n   2.3. [Cadastro de especificação para um carro](#cadastro-especificacoes)\n\n   2.4. [Cadastro de imagens para um carro](#cadastro-imagens-carro)\n\n   2.5. [Aluguel de carro](#aluguel-carro)\n\n   2.6. [Devolução de carro](#devolucao-carro)\n\n   2.7. [Listagem de aluguéis](#listagem-alugueis)\n\n3. [Comandos principais](#comandos-principais)\n\n   3.1. [Virtualização com Docker](#docker)\n\n   3.2. [Banco de dados](#database)\n\n## Informações gerais do projeto \u003ca name=\"informacoes-gerais\" /\u003e\n\nA car rental API\n\n## Requisitos da aplicação \u003ca name=\"requisitos-aplicacao\" /\u003e\n\n### Cadastro de carros \u003ca name=\"cadastro-carros\" /\u003e\n\n#### Requisitos funcionais\n\n- [x] Deve ser possível cadastrar um novo carro.\n\n#### Regras de negócio\n\n- [x] Não deve ser possível cadastrar um carro com uma placa já existente.\n- [x] O carro deve ser cadastrado, por padrão, com disponibilidade.\n- [x] O usuário responsável pelo cadastro deve ser um usuário administrador.\n\n### Listagem de carros \u003ca name=\"listagem-carros\" /\u003e\n\n#### Requisitos funcionais\n\n- [ ] Deve ser possível listar todos os carros disponíveis.\n- [ ] Deve ser possível listar todos os carros disponíveis pelo nome da categoria.\n- [ ] Deve ser possível listar todos os carros disponíveis pelo nome da marca.\n- [ ] Deve ser possível listar todos os carros disponíveis pelo nome do carro.\n\n#### Regras de negócio\n\n- [ ] O usuário não precisa estar logado no sistema.\n\n### Cadastro de especificação para um carro \u003ca name=\"cadastro-especificacoes\" /\u003e\n\n#### Requisitos funcionais\n\n- [ ] Deve ser possível cadastrar uma especificação para um carro.\n\n#### Regras de negócio\n\n- [ ] Não deve ser possível cadastrar uma especificação para um carro não cadastrado.\n- [ ] Não deve ser possível cadastrar uma especificação já existente para o mesmo carro.\n- [ ] O usuário responsável pelo cadastro deve ser um usuário administrador.\n\n### Cadastro de imagens para um carro \u003ca name=\"cadastro-imagens-carro\" /\u003e\n\n#### Requisitos funcionais\n\n- [ ] Deve ser possível cadastrar a imagem do carro.\n\n#### Requisitos não-funcionais\n\n- [ ] Deve utilizar o Multer para upload dos arquivos.\n\n#### Regras de negócio\n\n- [ ] O usuário deve poder cadastrar mais de uma imagem para o mesmo carro.\n- [ ] O usuário responsável deve ser um usuário administrador.\n\n### Aluguel de carro \u003ca name=\"aluguel-carro\" /\u003e\n\n#### Requisitos funcionais\n\n- [x] Deve ser possível cadastrar um aluguel.\n\n#### Regras de negócio\n\n- [x] O aluguel deve ter duração mínima de 24 horas.\n- [x] Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo usuário.\n- [x] Não deve ser possível cadastrar um aluguel caso já exista um aberto para o mesmo carro.\n- [x] O usuário deve estar logado na aplicação.\n- [x] Ao realizar um aluguel, o status do carro deverá ser alterado para indisponível.\n\n### Devolução de carro \u003ca name=\"devolucao-carro\" /\u003e\n\n#### Requisitos funcionais\n\n- [x] Deve ser possível realizar a devolução de um carro.\n\n#### Regras de negócio\n\n- [x] Se o carro for devolvido com menos de 24 horas, deverá ser cobrado diária completa.\n- [x] Ao realizar a devolução, o carro deverá ser liberado para outro aluguel.\n- [x] Ao realizar a devolução, o usuário deverá ser liberado para outro aluguel.\n- [x] Ao realizar a devolução, deverá ser calculado o total do aluguel.\n- [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.\n- [x] Caso haja multa, deverá ser somado ao total do aluguel.\n- [x] O usuário deve estar logado na aplicação.\n\n### Listagem de aluguéis para usuário \u003ca name=\"listagem-alugueis\" /\u003e\n\n#### Requisitos funcionais\n\n- [x] Deve ser possível a busca de todos os aluguéis para o usuário.\n\n#### Regras de negócio\n\n- [x] O usuário deve estar logado na aplicação.\n\n## Comandos principais \u003ca name=\"comandos-principais\" /\u003e\n\n### Virtualização com Docker \u003ca name=\"docker\" /\u003e\n\n#### Para criar a imagem\n\n```\ndocker build -t rentx .\n```\n\n#### Para executar o container\n\n```\ndocker run -p 3333:3333 rentx\n```\n\n#### Para subir os serviços com o Docker-compose\n\nOs dois comandos anteriores não são necessários caso use o Docker-compose.\n\n```\ndocker-compose up\n```\n\nPara subir os serviços em background:\n\n```\ndocker-compose up -d\n```\n\n### Banco de dados \u003ca name=\"database\" /\u003e\n\n#### Criar uma migration\n\n```\nyarn typeorm migration:create -n \u003cMIGRATION_NAME\u003e\n```\n\n#### Executar as migrations\n\n```\nyarn typeorm migration:run\n```\n\n#### Reverter migration\n\n```\nyarn typeorm migration:revert\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucas54neves%2Frentx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucas54neves%2Frentx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucas54neves%2Frentx/lists"}