===== Observatório de Educação Básica - Backend =====

O Backend do projeto OEB - Observatório de Educação Básica.

Endereço do servidor: [[https://oeb-server.herokuapp.com/ | https://oeb-server.herokuapp.com/]]

----

=== Dependências ===
  * [[https://nodejs.org/en/ | Node.js]] 8.0.0 ou >
  * [[https://yarnpkg.com/pt-BR/docs/install | Yarn]] ou Npm

----

=== Instalação e execução ===
  * Faça um clone do [[https://gitlab.com/escritorio-modelo/observatorio-de-educacao-basica/backend | repositório]];
  * Navegue até a pasta **backend** do projeto;
  * Rode **'npm install'** para instalar as dependências e criar a pasta **node_modules**;
  * Após a instalação das dependências, execute o comando **yarn md-seed run --dropdb** para recriar o banco de dados a partir das **seeds**.
  * Deve-se criar um arquivo **.env** na pasta **backend** do projeto com o seguinte conteúdo: 

    NODE_ENV=development
    APP_URL=http://localhost:8000
    MONGO_URL='mongodb://localhost/oeb'
    MONGO_TEST_URL="mongodb://localhost/oeb-test"
    SECRET='observatorio'
    APP_SECRET='observatorio'
    MAIL_HOST='smtp.mailtrap.io',
    MAIL_PORT=2525,
    MAIL_USER='19a3e8d58995ab',
    MAIL_PASS='3ee8443baae513'
    SENTRY_DSN=https://5442f5adc17b4cb1b9588b1708c0f28e@sentry.io/172675
    



  * Executar o comando **'yarn start'** para iniciar o **backend**

----

=== Comandos ===
Dentro do diretório do projeto você pode executar os seguintes comandos:
  * 'npm run dev' - Roda a aplicação em modo de desenvolvedor.
  * 'npm run test' - Roda os testes da aplicação.

----

=== Observações ===
  * Instale o [[https://insomnia.rest/download/ | Insomnia]] para testar todas as requisições do servidor. Neste [[https://app.slack.com/client/TENQ5EZ44/CHQB64UUF/user_profile/UMQQ8TREF | link]] você pode baixar um JSON com a nossa configuração atualizada, basta importar para dentro do Insomnia. 
  * Na raiz do projeto, adicione um arquivo chamado ´.env´ contendo todas as variáveis de ambiente. Para manter um padrão, utilize [[https://app.slack.com/client/TENQ5EZ44/CHQB64UUF/user_profile/UMQQ8TREF | este modelo]]