Catálogo de entidades sociais com o objetivo de diminuir a distância entre entidades do terceiro setor e volutáriado.
Para contribuir com o front end da ongbook, é necessário ter os pré requisitos instalados, seguir as boas práticas utilizadas no projeto e caso tenhas dúvida, abra uma issue :)
É necessário ter instalado o Node.JS instalado na sua máquina.
Caso tenha dúvidas para a instalação, este artigo pode lhe ser útil.
Para instalar o projeto em sua máquina, siga os passos abaixo:
Crie uma pasta para o projeto e acesse ela:
$ mkdir ongbook && cd ongbook
Instale as dependências do projeto através do npm:
$ npm install
Para você rodar o projeto em um navegador basta utilizar:
$ npm start
Você pode alterar a porta conforme sua necessidade.
Para os testes unitários, estamos utilizando o Mocha, Chai e Sinon com a metodologia do TDD.
Para fazer o teste do projeto em modo de produção, com compressão e certificar de que tudo está ok:
$ npm prod
- Angular 1.x - Framework utilizado.
- Npm - Gerenciador de dependências.
- Travis CI - Integração contínua.
- Heroku - Cloud
Para contribuir basta acessar a sessão de CONTRIBUTING.md, lá você pode buscar informações de como trabalhamos usando o Gitflow e como você deve submeter suas alterações.
Utilizamos o Git para o versionamento. Você pode acompanhar nossos releases através das tags nos repositórios.
Veja nossa lista de contribuidores.
Optamos por utilizar a licença do MIT License - LICENSE.md para detalhes.