Commit 03557c5cbd28a8b5f12a63a3d201cc3f30b438cd
1 parent
0f498341
Exists in
master
and in
4 other branches
Atualização do Readme com o passo a passo para colaboração
Showing
1 changed file
with
25 additions
and
7 deletions
Show diff stats
README.md
| 1 | 1 | Site base dos debates públicos dentro do ambiente do Pensando o Direito |
| 2 | 2 | =================== |
| 3 | 3 | |
| 4 | -Esse repositório contém os códigos fonte do site base dos debates públicos do Pensando o Direito. | |
| 4 | +Esse repositório contém os descritores para instalação do ambiente base das plataformas de debate público. A estrutura de publicação dos arquivos buscou seguir algumas sugestões do Bedrock Stack (http://roots.io/wordpress-stack/). Até onde é possível, usamos boas práticas pra publicação e organização dos códigos. Algumas tecnologias que estamos utilizando: | |
| 5 | 5 | |
| 6 | -Para baixar, você precisará de um cliente GIT e do Composer instalado. Baixe o composer aqui: | |
| 6 | +* Apache/PHP/MySQL | |
| 7 | +* WordPress | |
| 8 | +* Plugin Delibera | |
| 9 | +* Vagrant/VirtualBox | |
| 10 | +* Composer | |
| 7 | 11 | |
| 8 | -https://getcomposer.org/ | |
| 12 | +Para começar, você deverá ter o VirtualBox e o Vagrant instalado na sua máquina. Não que isso seja um condicionante, você também poderá montar o seu ambiente "na mão", mas o Vagrant automatiza muito da montagem do ambiente para você. | |
| 9 | 13 | |
| 10 | -Faça clone do projeto na sua máquina e dentro do diretório do projeto baixado execute: | |
| 14 | +Com o Vagrant instalado, clone esse repositório na sua máquina local, e dentro do diretório que acaba de baixar, execute o comando "vagrant up". Isso fará com que o vagrant baixe a "box" que estamos utilizando no projeto e faça o provisionamento dela, ou seja, execute alguns comandos que estão no arquivo Vagrantfile, na raiz do respositório. | |
| 11 | 15 | |
| 12 | -$ composer install | |
| 16 | +Como estamos usando o WordPress multisites, precisaremos ocupar a porta 80 padrão pra montagem da nossa plataforma. O Vagrant tentará levantar a plataforma nessa porta. Se você já tem um webserver ocupando essa porta, desative-o enquanto estiver trabalhando na plataforma de debates públicos. | |
| 13 | 17 | |
| 14 | -Isso baixará todos os arquivos que o projeto depende, inclusive os códigos do WordPress. | |
| 18 | +O Vagrant também terá fazer um direcionamento de portas da 80 pra 8080, para o caso de falha do levantamento de portas baixas por conta de permissões. Para isso, ele pedirá sua senha de usuário pra fazer um "sudo". | |
| 15 | 19 | |
| 16 | -Para rodar na sua máquina, você precisará de um servidor LAMP (Linux Apache MySQL PHP). Aponte o diretório raiz do servidor para o diretório do projeto e faça a instalação do WordPress. A partir daí você já deve ter o ambiente instalado na sua máquina. Vamos codar! | |
| 20 | +Caso você não queira usar o Vagrant, e montará toda sua infra na mão, não tem problema. Use os scripts de config e db na raiz desse diretório para montar sua infra de servidor Apache e MySQL. Depois, execute o comando "composer update" para baixar todas as dependências de projeto necessárias. Se você não tem o composer instalado na sua máquina, baixe-o daqui (https://getcomposer.org/). | |
| 21 | + | |
| 22 | +Com isso, se você acessar em seu navegador a url http://localhost, você já deve ver a tela iniciar da plataforma de debates. | |
| 23 | + | |
| 24 | +<h4>Contribuindo com o código</h4> | |
| 25 | + | |
| 26 | +Caso você queira fazer alguma contribuição, é recomendado você "forkar" o repositório no github. Para isso, você precisará ter um usuário nessa plataforma. Feito o "fork", você terá uma cópia do repositório na sua máquina com uma URL de origem diferente, por exemplo: http://github.com/marcoamarelo/marcocivil-tema. Com esse diretório, você deverá configurar a origin do repositório que você tem baixado na sua máquina para o seu "fork". Um exemplo de comando pra fazer isso é: | |
| 27 | + | |
| 28 | +``` | |
| 29 | +$ git remote set-url origin git@github.com:USERNAME/REPOSITORY2.git | |
| 30 | +``` | |
| 31 | + | |
| 32 | +Dessa forma, você poderá fazer todas as alterações necessárias no seu respositório e depois solicitar um pull request para o projeto. | |
| 33 | + | |
| 34 | +Em caso de dúvidas ou contribuições, escreva para marco.konopacki@mj.gov.br | ... | ... |