Git Product home page Git Product logo

rent-api's Introduction

rent-api

API de aluguel de carros.

Como iniciar

Após baixar o repositório, a forma mais simples é utilizando docker.

É possível iniciar a aplicação com o comando:

docker-compose up

ou

docker-compose up -d # para iniciar no modo detached

Este comando iniciará o backend, junto com uma instância do MongoDB e o mongo-express, um cliente para acesso ao banco.

A api roda na porta 3000, o MongoDB na porta 27017 e o mongo-express na porta 8081.

Na primeira execução do comando o docker vai baixar as imagens necessárias e gerará um build da aplicação dentro da imagem, assim como um seed no banco de dados.

Para ambiente de desenvolvimento temos

npm run start:dev

que inicia o projeto utilizando o ts-node e o nodemon.

a url de acesso ao banco é configurada via variável de ambiente, e segue o formato:

DB_URL=DB_URL=mongodb://<usuario>:<senha>@172.17.228.115:27017

já definida no docker-compose.yml

Aplicação

A aplicação utiliza o express para a comunicação http, e o driver oficial do mongoDB para acesso ao banco, não foi utilizado ORM.

Fiz testes, mas foquei mais em testes unitários do domínio, não há testes de integração.

Há uma configuração de workflow do github para executar os testes e fazer análise de qualidade com o SonarQube.

Observações e considerações

Não foi implementado nenhum tipo de autenticação, o que está longe de ser algo aceitável para uma aplicação no mundo real, o que define se o usuário está logado ou não é a presençã de um objeto no frontend.

O CORS foi configurado, porém liberado para todas as origens.

Os erros previstos na aplicação estão sendo lançados em forma de texto simples, seria ideal ter classes de exceções personalizadas.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.