caiovinicius7 / ignite-node-rentx Goto Github PK

Rentx é um sistema de gerenciamento feito para uma agência de aluguel de carros, o projeto foi desenvolvido para estudos seguindo a trilha de node.js do ignite da rocktseat, ele visa facilitar a vida dos funcionários e deixar a administração dos aluguéis e dos veículos mais simples e ágil.

O sistema conta com as seguintes funcionalidades:

• Autenticação de usuário
• Cadastro de usuário
• Cadastro de veículo
• Cadastro de categorias
• Cadastro de especificações
• Cadastro e devolução de aluguel

Caso queira ver as funcionalidades por completo e de modo técnico acesse a documentação do projeto (clique aqui para ver como acessá-la).

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Docker e Insominia ou Postman.

# Clone este repositório
$ git clone https://github.com/CaioVinicius7/ignite-node-rentx.git

# Acesse a pasta do projeto no terminal/cmd
$ cd ignite-node-rentx

# Acesse o projeto pelo vs code 
$ code .

# crie os arquivos .env e ormconfig.json seguindo os arqivos de exemplo

# Faça o build dos containers
$ docker-compose build

# Execute os containers
$ docker-compose up -d

# Rode as migrations
$ npm run typeorm migration:run ou yarn typeorm migration:run

# Rode a seed de usuários administradores
$ npm run seed:admin ou yarn seed:admin

# O servidor ficara ativo na porta:3333 - acesse <http://localhost:3333>

OBS: Não esqueça de criar um arquivo.env e ormconfig.json antes de buildar os containers.

Para ter acesso a documentação utilize a rota /api-docs após a inicialização da aplicação, como no exemplo abaixo ou clique aqui.

http://localhost:3333/api-docs/

OBS: Na raiz do projeto existe um arquivo collection.json, importe no insomnia ou postman para ter acesso a todas as rotas sem necesidade de adicioná-las do zero.