Skip to content

Ygohr/rentx-ignite-nodejs

Repository files navigation

⚔️ Ignite - RentX


📌 About

Essa API foi construída com NodeJS + Typescript como uma empresa fictícia de aluguel de carros chamada RentX durante o curso Ignite de NodeJS da Rocketseat. A aplicação possui as seguintes funcionalidades:

  • Cadastro de usuários
  • Autenticação de usuários e geração de token
  • Cadastro de carros e itens relacionados ao carro como especificações e categorias
  • Realização de um aluguel e devolução do carro
  • Recuperação de senha do usuário através de e-mail

📋 Requisitos e Regras de Negócio

O documento de referência de Requisitos e Regras de Negócio pode ser acessado através deste link.

💻 Instalação, Dependências e Executando o Projeto

1. Clone este repositório

git clone git@github.com:Ygohr/rentx-ignite-nodejs.git

2. Vá até o diretório raiz do projeto

cd rentx-ignite-nodejs

3. Instale as dependências necessárias

yarn 
ou
npm install

4. Execute a aplicação

yarn dev

💾 Usando a Aplicação

Para realização de requisições na aplicação, deve ser utilizado o Insomnia ou Postman, importando o arquivo de requisições já existente neste diretório. Atentar-se aos parâmetros necessários no Header.

💉 Evidência de Testes

Nesta aplicação, são contemplados Testes Unitários e Testes de Integração utilizando o framework de testes Jest, visando garantir o correto funcionamento das funcionalidades e manter a aplicação de acordo com os requisitos.

  • Desenvolvido por Ygohr 🤖