Sobre • RentX • Instalação • Tecnologias • Autor
Projeto criado durante o módulo II do bootcamp Ignite da Rocketseat na trilha de NodeJS.
O RentX é uma API REST para uma aplicação de aluguel de carros desenvolvida em NodeJS, Redis, Postgres e outras tecnologias.
O projeto foi criado durante o segundo módulo do curso que teve como alguns dos conteúdos:
- Criação de aplicações utilizando TypeScript.
- Padrões de código e princípios do SOLID.
- Conceitos importantes como:
- Casos de uso.
- Repositórios.
- Models.
- Streams.
- Documentação de APIs com Swagger.
O RentX é um projeto completo com muitos conceitos, do básicos ao avançado, e com diversas tecnologias envolvidas como por exemplo:
- Docker.
- Postegres.
- Redis.
- AWS S3.
A documentação da API foi disponibilizada em swagger e as instruções para sua visualização estão disponíveis no tópico instalação.
Deixo abaixo a modelagem do banco de dados da aplicação para um rápida visualização da estrutura que foi construída para essa API:
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e Docker. Além disso é bom ter um editor para trabalhar com o código como VSCode.
# Clone este repositório
$ git clone git@github.com:MrRioja/rentx.git
# Acesse a pasta do projeto no terminal/cmd
$ cd rentx
# Instale as dependências
$ npm install
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn
# Crie o ambiente com Docker
$ docker-compose up -d --build
# Execute as seeds para popular o banco de dados
$ yarn seed:admin
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn dev
# Execute os testes da aplicação
$ yarn test
# O servidor iniciará na porta 3333 - acesse <http://localhost:3333>
# A documentação da API estará disponível na rota /api-docs
