osamuca / ongbook-front-end

Front End Ongbook

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Coverage Status Open Source Love MIT Licence

Ongbook

Catálogo de entidades sociais com o objetivo de diminuir a distância entre entidades do terceiro setor e volutáriado.

Formas de colaboração

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 :)

Pré requisitos

É necessário ter o Node.JS instalado na sua máquina.

Caso tenha dúvidas para a instalação, este artigo pode lhe ser útil.

Instalação

Para instalar o projeto em sua máquina, faça um fork do projeto e siga os passos abaixo:

Crie uma pasta para o projeto e acesse ela:

$ git clone https://github.com/seu-usuario/ongbook-front-end.git

Instale as dependências do projeto através do comando npm:

$ npm install

Para você rodar o projeto localmente basta utilizar o comando para iniciar o projeto:

$ npm start

Testes

Para os testes, estamos utilizando o Mocha, Chai e Sinon.

Para rodar os testes basta utilizar:

$ npm test

Cobertura de testes

Cara conferir a cobertura de testes utilize o comando abaixo:

$ npm run couverage

Feito em

Como contribuir!

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.

Versionamento

Utilizamos o Git para o versionamento. Você pode acompanhar nossos releases através das tags nos repositórios.

Autores

Veja nossa lista de contribuidores.

Licença

Optamos por utilizar a licença do MIT License - LICENSE.md para detalhes.

Para tirar dúvidas sobre o projeto e sobre formas de contribuição, disponibilizamos dos seguintes canais:

  • Gitter - Dúvidas sobre contribuições.
  • Sugestões e Dúvidas através de issues aqui no Github.

Redes Sociais

About

Front End Ongbook

License:MIT License


Languages

Language:HTML 53.7%Language:CSS 31.6%Language:JavaScript 14.8%