Como contribuir

Para rodar o projeto no seu computador, tenha certeza que você tem o Node e o npm instalado. Para tanto, digite o seguinte comando no terminal:

$ node --version
v7.6.0

$ npm --version
v5.0.0

Nota: A sua versão do Node deve ser maior ou igual a 7.6.0 pois o projeto utiliza algumas funcionalidades que só estão implementadas nas versões mais novas do Node. Se você tem uma versão mais antiga instalada, siga as instruções no site do Node para instalar uma versão mais atualizada.

Com o Node e o npm instalados, clone o repositório e execute o comando npm install para instalação das dependências.

Clone e instalação das dependências

$ git clone https://github.com/lar-ect/plataforma-lop.git
$ cd plataforma-lop
$ npm install

Variáveis de ambiente

Antes de rodar o projeto, precisamos configurar algumas variáveis de ambiente que serão utilizadas como configuração. Há algumas variáveis de exemplo no arquivo variables.env.sample.

Crie um novo arquivo com o nome variables.env e copie as informações do arquivo de exemplo para esse novo arquivo.

NODE_ENV=development
DATABASE=mongodb://localhost:27017/lop_db
PORT=3000
SECRET=chave
KEY=secreta
POSTMARK_TOKEN=XXXX
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_CALLBACK_URL=http://localhost:8080/auth/github/callback
SIGAA_CLIENT_ID=
SIGAA_CLIENT_SECRET=

As linhas SECRET e KEY são utilizadas para o gerenciamento de sessões e autenticação do servidor, e podem conter qualquer valor enquanto estivermos em desenvolvimento. Ao colocar o sistema em produção, deve-se atentar para mudar os valores dessas variáveis.

Em seguida, precisamos atentar para a linha DATABASE. O projeto utiliza MongoDB como banco de dados para armazenar as informações e para isso precisamos fornecer uma url de conexão com uma instância do Mongo.

Instalando o MongoDB

O jeito mais fácil de utilizar o mongoDB é criar uma conta no site mLab e rodar uma instância na nuvem. Caso você deseje rodar o mongo localmente, siga os tutoriais oficiais para instalação:

• Ubuntu
• Windows
• OSX - Use Homebrew

Após a instalação, substitua o campo DATABASE no arquivo variables.env pelo link de acesso ao seu mongo:

• Exemplo mLab: mongodb://usuario:senha@ds129422.mlab.com:29422/nome-do-banco
• Exemplo Local: mongodb://usuario:senha@localhost:27017/nome-do-banco

Como extra, recomendo o Robo 3T para acessar o banco e visualizar os dados.

Rodando o projeto

Em seguida, já estamos aptos a rodar o projeto e fazer modificações no mesmo utilizando o comando npm start:

$ npm start
Servidor rodando na porta: 8080
...

Algumas outras mensagens serão exibidas no terminal, mas já podemos abrir a url http://localhost:8080 no navegador que o projeto vai estar rodando.

Para saber mais sobre as tecnologias utilizadas, visite a página da wiki sobre tecnologias do projeto