Para contribuir com o projeto veja o guia de Contribuição. Lá você encontrará instruções detalhadas de como fazer a sua contribuição.
- Python 3.6
- pip
- Para apenas rodar localmente o site, você precisa do virtualenv instalado na sua máquina. Para verificar se ele está instalado, execute o seguinte comando e observe a saída:
$ virtualenv --version- Se a saída for uma numeração, como
16.1.0, isso significa que o virtualenv já está instalado. Caso contrario, para instalar o virtualenv basta fazer:
$ pip install virtualenv- O mesmo procedimento pode ser feito para o git. Verifique se já está instalado, com o comando:
$ git --version- Se a saída for algo como
git version 2.17.1, significa que o git já está instalado. Caso contrário, para instalar o git basta fazer:
$ sudo apt install git # para ubuntuObservação: Esse comando funciona apenas em sistemas operacionais que utilizam o
aptgerenciador de pacotes. Caso não seja o seu caso, verifique como instalar o git no seu sistema.
- Assumindo que seu git e virtualenv já estão configurados, faça o clone do repositório
$ git clone https://github.com/pyladies-brazil/br-pyladies-pelican.git- Após conclusão do clone, acesse o diretório recém-criado
$ cd br-pyladies-pelican- Rode o comando para criação de ambiente virtual e instalação das dependências
$ virtualenv .venv # cria ambiente virtual
$ source .venv/bin/activate # ativa o ambiente
$ pip install -r requirements.txt # instala as dependências
- Rode o projeto
$ make upAbra o browser em localhost:8000 para ver o conteúdo gerado.
Observação: Se sua porta 8000 já estiver em uso, você pode especificar uma porta diferente ao
usar o parâmetro PORT. Por exemplo:
$ make up PORT=8001E então acessar localhost:8001. Atenção! Algumas portas são reservadas.
Para desativar o ambiente virtual
$ deactivatePara mais informações a respeito do Makefile e suas opções, digite
$ make helpInstale o docker no seu computador em seguida execute os passos abaixo:
$ git clone [email protected]:pyladies-brazil/br-pyladies-pelican.git
$ cd br-pyladies-pelican
$ docker-compose up-
[Opcional] Instale o Visual Studio Code para fazer códigos legais;
-
[Opcional mas fortemente indicado] Instale o Github Desktop para uma interface legal também;
-
Python 3.8 está disponível na loja do Windows e você deve instalar também. Só procurar e clicar em obter que está tudo certo;
-
Abra o Windows Powershell como administrador e faça a instalação do chocolatey. Com ele poderemos instalar o comando make que será utilizado junto ao Docker;
-
Com o comando choco sendo reconhecido no Windows, instale o make com
choco install make; -
Por último, faça a instalação do Docker, certifique-se que os requisitos mínimos estão sendo cumpridos. Para o Windows 10 Home, é recomendado que atualize o sistema antes da instalação (Configurações → Atualização e Segurança → Windows Update)
- Atente-se se o WSL2 está rodando na sua máquina. Se ainda for o WSL, atualize.
-
Faça fork do repositório;
-
Reinicie o computador para garantir que todas as mudanças foram efetuadas e salvas;
-
Agora você tem duas formas de rodar o projeto seguindo o:
- Comando
make up - Comando
docker-compose up
- Comando
-
Utilizando o terminal:
$ git clone [email protected]:pyladies-brazil/br-pyladies-pelican.git $ cd br-pyladies-pelican $ docker-compose up
ou
$ git clone [email protected]:pyladies-brazil/br-pyladies-pelican.git $ cd br-pyladies-pelican $ make up
Qualquer dúvida ou problema durante a instalação, abra uma issue!
Esse repositório é mantido com ❤️ pelo @pyladies-brazil/tech-team
