Como Contribuir

Esse é um projeto desenvolvido pelo PHP-SP (Grupo de desenvolvedores PHP do Estado de São Paulo) (http://phpsp.org.br/) para a Liga Solidária (http://www.ligasolidaria.org.br/) Você pode conhecer um pouco mais sobre o trabalho da ONG nos respectivos sites.

Você pode contribuir com o projeto de diversas formas que incluem mas não se limitam a:

1. Testar o sistema e informar no GitHub caso encontre alguma falha
2. Sugerir novas funcionalidades também através do GitHub
3. Corrigir falhas já informadas no GitHub
4. Desenvolver novas funcionalidades

Porem antes de realizar algum trabalho que tome um tempo considerável recomendo que abra um issue no GitHub informando sobre sua contribuição e aguarde uma resposta, somente para evitar que duas pessoas realizem o mesmo trabalho. Se considerar que a alteração que irá fazer é tão pequena que não irá tomar nenhum tempo considerável pode pular essa parte.

Para Enviar Contribuições

1. Faça o Fork
2. Clone Localmente (git clone git://github.com/usuario-do-git/liga-solidaria-storage.git)
3. Crie seu branch feature (git checkout -b minha-nova-feature)
4. Faça o commit das suas alterações (git commit -am 'Adiciona alguma feature')
5. Faça o Push para o seu Fork (git push origin minha-nova-feature)
6. Crie um novo Pull Request

Para Rodar o Projeto

Copie as Configurações

Faça uma copia do arquivo config/config.ini.dist e renomei para config/config.ini os dados para acesso ao sistema estão nesse arquivo, você pode consulta-lo para saber quais são as credenciais ou altera-lo para refletir suas preferencias.

Não altere diretamente o arquivo config/config.ini.dist a não ser que deseje que essa alteração seja publicada, o arquivo config/config.ini é ignorado pelo controle de versão, então qualquer alteração pessoal deve ser feita nesse arquivo.

Resolva as Dependências

O projeto uso Composer (www.getcomposer.org) para resolver as dependências de bibliotecas utilizadas pelo composer, por isso antes de executar o sistema você precisa realizar o download dessas dependencias da seguinte forma:

1. Faça o Download do Composer ( http://getcomposer.org/download ) (Se já não tiver instalado)
2. Copie o arquivo composer.phar para dentro do root do projeto (Se não estiver instalado globalmente)
3. Execute os comandos:

   php composer.phar self-update
   php composer.phar install --dev

Crie um Virtual Host

Crie um Virtual Host no servidor web que estiver utilizando apontando diretamente para a pasta public do seu repositório local, dessa forma o sistema poderá resolver corretamente as rotas. Não se esqueça de alterar o seu arquivo de hosts.

Use o PHP Built-in Server (Alternativa)

Para isso navegue pela linha de comando até dentro do diretório public do seu repositório e execute o seguinte comando:

$ php -S localhost:8080

Feito isso acesso do seu navegador http://localhost:8080

Use Vagrant (Alternativa 2)

Você vai precisar baixar e instalar: o Vagrant e o VirtualBox.

Com ambos instalados, você deve clonar o repositório para um diretório (que a part desse momento chamaremos de docroot).

Dentro do docroot em algum terminal, você precisa primeiro instalar um plugin do vagrant que irá baixar (e gerenciar) os demais plugins necessários e depois subir a VM com os comandos:

$ vagrant plugin install bindler && vagrant bindler setup && vagrant plugin bundle
$ vagrant up && vagrant provision

Você já deve conseguir acessar: http://liga-solidaria-storage.localhost/ Se algum erro aconteceu no processo acima, abra um bug com todo o output do seu terminal.

Dúvidas

Qualquer outra duvida fique a vontade para abrir uma issue no GitHub pois dessa forma todos os envolvidos no projeto terão acesso a sua dúvida e poderão responder mais rapidamente.