{"id":22253631,"url":"https://github.com/renanfachin/rs_ig_rentxapi","last_synced_at":"2026-05-03T19:33:46.263Z","repository":{"id":211345077,"uuid":"728875144","full_name":"RenanFachin/RS_IG_RentXAPI","owner":"RenanFachin","description":"Aplicação de aluguéis de carros desenvolvida no Ignite Node.js, utilizando POO e princípios do SOLID para sua elaboração","archived":false,"fork":false,"pushed_at":"2023-12-27T22:59:03.000Z","size":695,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T12:30:55.176Z","etag":null,"topics":["ignite-nodejs","node-streams","nodejs","postgresql-database","solid","tdd"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RenanFachin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-07T22:17:12.000Z","updated_at":"2023-12-21T01:27:59.000Z","dependencies_parsed_at":"2025-03-25T12:41:33.938Z","dependency_job_id":null,"html_url":"https://github.com/RenanFachin/RS_IG_RentXAPI","commit_stats":null,"previous_names":["renanfachin/rs_ig_rentalxapi","renanfachin/rs_ig_rentxapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RenanFachin/RS_IG_RentXAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenanFachin%2FRS_IG_RentXAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenanFachin%2FRS_IG_RentXAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenanFachin%2FRS_IG_RentXAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenanFachin%2FRS_IG_RentXAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RenanFachin","download_url":"https://codeload.github.com/RenanFachin/RS_IG_RentXAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RenanFachin%2FRS_IG_RentXAPI/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32582779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["ignite-nodejs","node-streams","nodejs","postgresql-database","solid","tdd"],"created_at":"2024-12-03T07:19:14.212Z","updated_at":"2026-05-03T19:33:46.246Z","avatar_url":"https://github.com/RenanFachin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## RentX API\nA RentX API é uma aplicação destinada à gestão e controle de aluguel de veículos. Desenvolvida para proporcionar uma experiência eficiente e segura, a API oferece uma variedade de funcionalidades que abrangem desde o cadastro de usuários até a gestão completa de reservas e devoluções.\n\n## Análise de Requisitos\nA RentX API atende a uma série de requisitos funcionais e não funcionais, garantindo a integridade dos dados, a segurança das transações e a experiência do usuário. Além disso, diversas regras de negócio são implementadas para manter a consistência e o bom funcionamento da aplicação.\n\n### Requisitos Funcionais\n**Cadastro de usuário**\n- [x] Deve ser possível realizar o cadastro de um novo usuário.\n**Cadastro de categoria**\n- [x] Deve ser possível cadastrar uma categoria para um veículo.\n**Cadastro de carro**\n- [X] Deve ser possível cadastrar um novo carro.\n**Listagem de carros**\n- [x] Deve ser possível listar todos os carros disponíveis.\n- [x] Deve ser possível listar todos os carros disponíveis pelo nome da categoria.\n- [x] Deve ser possível listar todos os carros disponíveis pelo nome da marca.\n- [x] Deve ser possível listar todos os carros disponíveis pelo nome do carro.\n**Cadastro de Especificação no carro**\n- [x] Deve ser possível cadastrar uma especificação para um carro.\n**Cadastro de imagens do carro**\n- [x] Deve ser possível cadastrar a imagem do carro.\n**Aluguel de carro**\n- [x] Deve ser possível cadastrar um aluguel.\n**Devolução de carro**\n- [x] Deve ser possível realizar a devolução de um carro alugado\n**Listagem de alugueis para usuário**\n- [x] Deve ser possível realizar a busca de todos os alugueis para o usuário\n**Recuperação de senha**\n- [x] Deve ser possível que o usuário consiga recuperar a senha informando o e-mail de registro.\n- [x] O Usuário deve receber um e-mail com o passo a passo para a recuperação da senha.\n- [x] O Usuário deve conseguir cadastrar uma nova senha.\n\n### Requisitos Não Funcionais\n- [x] O usuário com permissão de admin deve ser criado via seed.\n- [x] O banco de dados deve ser PostgreSQL.\n**Cadastro de imagens do carro**\n- [x] Utilizar o multer para upload dos arquivos de imagem.\n\n### Regra de negócio\n**Cadastro de usuário**\n- [x] Não deve ser possível realizar o registro de um usuário que já tenha o email utilizado cadastrado.\n- [x] A senha do usuário deve estar criptografada\n**Cadastro de categoria**\n- [x] Um veículo só pode ter uma categoria vinculada a ele.\n**Cadastro de carro**\n- [x] Não deve ser possível cadastrar um carro com uma placa já cadastrada.\n- [X] O carro deve ser cadastrado, por padrão, com a propriedade available como true.\n- [x] O usuário responsável pelo cadastro deve ser um usuário adminstrador.*\n**Listagem de carros**\n- [x] O usuário não precisa estar autenticado no sistema para listar os carros.\n**Cadastro de Especificação no carro**\n- [x] Não deve ser possível cadastrar uma especificação para um carro não cadastrado.\n- [x] Não deve ser possível cadastrar uma especificação que já esteja cadastrada em um veículo.\n- [x] O usuário responsável pelo cadastro de especificação deve ser um usuário adminstrador.\n**Cadastro de imagens do carro**\n- [x] O usuário deve poder cadastrar mais de uma imagem para o mesmo carro.\n- [x] O usuário responsável pelo cadastro das imagens deve ser um usuário adminstrador.\n**Alugel de carro**\n- [x] O usuário deve ser autenticado na aplicação para fazer uma reserva.\n- [x] O aluguel deve ter duração mínima de 24 hora.\n- [x] Não deve ser possível cadastrar um novo aluguel caso já exista um aberto para o mesmo usuário.\n- [x] Não deve ser possível cadastrar um novo aluguel caso já exista um aberto para o mesmo carro.\n- [x] Ao realizar o aluguel, o status do carro deverá ser alterado para indisponível.\n**Devolução de carro**\n- [x] Se o carro for devolvido com menos de 24 horas, deverá ser cobrado a 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 em atraso.\n- [x] Caso haja multa, deverá ser somado ao total do aluguel.\n- [x] O usuário deve estar logado e autenticado para realizar a devolução.\n**Listagem de alugueis para usuário**\n- [x] O usuário deve estar logado na aplicação\n**Recuperação de senha**\n- [x] O usuário precisa informar a uma nova senha\n- [x] O link enviado para recuperação deve expirar em 3 horas\n\n## Configuração do Projeto\n\nPara executar este projeto localmente, siga as etapas abaixo:\n\n```bash\n# Clone o repositório\ngit clone https://github.com/RenanFachin/RS_IG_RentalXAPI.git\n\n# Acesse a pasta do projeto\n# Instale as dependências\nnpm install\n\n# Execute a aplicação em ambiente de desenvolvimento\nnpm run dev\n```\n\nSubindo um container de um database com postgres\n```bash\ndocker-compose up\n```\n\nCriando as tabelas (Rodando as migrations)\n```bash\nnpm run typeorm migration:run\n```\n\nRodando o seed para criar um usuário com permissão de admin\n```bash\nnpm run seed:admin\n```\n\n## Documentação do projeto\n\nPara acessar a documentação, é necessário iniciar o servidor e após isto acessar **http://localhost:3333/api-docs**\n\n\u003c!-- ### /categories\n\n#### POST\n##### Summary:\n\nCreate a category\n\n##### Description:\n\nCreate a new category\n\n##### Responses\n\n| Code | Description |\n| ---- | ----------- |\n| 201 | Created |\n| 500 | Category already exists |\n\n#### GET\n##### Summary:\n\nList all registered categories\n\n##### Responses\n\n| Code | Description |\n| ---- | ----------- |\n| 200 | Success |\n\n### /categories/import\n\n#### POST\n##### Summary:\n\nUpload a new category\n\n##### Description:\n\nUpload a new category\n\n##### Responses\n\n| Code | Description |\n| ---- | ----------- |\n| 201 | Created |\n\n### /specifications\n\n#### POST\n##### Summary:\n\nCreate a specification\n\n##### Description:\n\nCreate a new specification\n\n##### Responses\n\n| Code | Description |\n| ---- | ----------- |\n| 201 | Created |\n| 500 | Specification already exists |\n\n### Models\n\n\n#### Specification\n\n| Name | Type | Description | Required |\n| ---- | ---- | ----------- | -------- |\n| name | string |  | No |\n| description | string |  | No | --\u003e\n\n\n\u003c!-- Libs utilizadas --\u003e\n\u003c!-- https://www.npmjs.com/package/tsx --\u003e\n\u003c!-- https://www.npmjs.com/package/uuid --\u003e\n\u003c!-- https://www.npmjs.com/package/typescript --\u003e\n\u003c!-- https://www.npmjs.com/package/multer --\u003e \n\u003c!-- https://www.npmjs.com/package/csv-parse --\u003e\n\u003c!-- https://www.npmjs.com/package/swagger-ui-express --\u003e\n\u003c!-- https://typeorm.io/ --\u003e\n\u003c!-- https://www.npmjs.com/package/tsyringe --\u003e\n\u003c!-- https://www.npmjs.com/package/bcrypt --\u003e\n\u003c!-- https://www.npmjs.com/package/jsonwebtoken --\u003e\n\u003c!-- https://www.npmjs.com/package/express-async-errors --\u003e\n\u003c!-- https://jestjs.io/pt-BR/ --\u003e\n\u003c!-- https://www.npmjs.com/package/supertest --\u003e\n\u003c!-- https://ethereal.email/ --\u003e\n\u003c!-- https://handlebarsjs.com/ --\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanfachin%2Frs_ig_rentxapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenanfachin%2Frs_ig_rentxapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanfachin%2Frs_ig_rentxapi/lists"}