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

O Backend do 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 do projeto;
  - Rode `npm install` para instalar as dependências;
  - Execute `npm run dev` para iniciar o servidor em modo de desenvolvimento.

----


=== 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]]