Giter VIP home page Giter VIP logo

backend-v1's Introduction

Backend

Código do backend para o aplicativo e dashboard do Insper Mileage.

Link encurtado: https://git.io/0

Read this in English and Portuguese

Começando

Essas instruções vão fazer com que você tenha uma cópia do projeto rodando em sua máquina local para desevolvimento e testes. Veja o tópico de deployment para ver como colocar o projeto em produção.

Pré-Requisitos

Para executar o projeto, você precisa ter instalado em sua máquina: NodeJS e Yarn ou Docker, que criará um container com as dependências:

NodeJS (v10.x.x)

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs

Yarn (v1.16.0)

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt-get update && sudo apt-get install yarn

Docker e Docker Compose

Para facilitar a instalação em um sistema Ubuntu 18.04 - 18.10, execute o programa:

./docker-install

Instalação e execução

Crie um arquivo .env com o seguinte texto:

MONGO_URL=<URL_DO_BANCO_DE_DADOS_MONGO>
PORT=3333

Executando na máquina local

Para instalar as dependências do projeto e executá-lo:

$ yarn
$ yarn start

Para executar em modo desenvolvedor, em que a cada modificação de arquivo o programa é reiniciado:

$ yarn dev

Executando em Docker

Para executar o projeto utilizando Docker, builde a imagem:

$ docker-compose build

Para iniciar o container:

$ docker-compose up -d

obs: Utilize a flag -d para executar em segundo plano.

Demonstração

Integridade do projeto

Testes

[Quais são os testes e porque são importantes]

Executando os testes

[Como executar testes automatizados do projeto]

Deployment

[Como fazer o deploy do projeto para um ambiente de produção]

Desenvolvido com

  • NodeJS (Express, Mongoose)
  • MongoDB
  • Docker

Contribuindo

Por favor leia CONTRIBUTING para mais detalhes sobre o nosso código de conduta e processo para submeter um Pull Request.

Licença

Esse projeto está licenciado sobre a licença MIT - veja o arquivo LICENSE.md para mais detalhes.

backend-v1's People

Contributors

dependabot[bot] avatar martimfj avatar

Watchers

 avatar

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.