Bem-vindo ao projeto BookHeaded! Obrigado por considerar contribuir para o nosso projeto! Siga as instruções abaixo para configurar o ambiente de desenvolvimento.
Antes de começar, certifique-se de ter o seguinte instalado na sua máquina:
Abra seu terminal e navegue até o diretório onde deseja clonar o repositório. Em seguida, execute o comando abaixo:
git clone https://github.com/Carlosesposito22/BookHeaded.git
Use o comando
cd BookHeaded
Para criar um ambiente virtual, execute o seguinte comando:
python -m venv venv
Para ativar o ambiente virtual:
source venv/Scripts/activate
source venv/bin/activate
Com o ambiente virtual ativado dentro da mesma pasta, instale as dependências necessárias:
pip install -r requirements.txt
Realize as migrações no banco usando: (Note que em algums dispositivos é usado py como prefixo ao inves de python)
python manage.py migrate
Finalmente, para iniciar o servidor de desenvolvimento, execute:
python manage.py runserver
Agora, você deve ser capaz de acessar o aplicativo em seu navegador, normalmente o servidor local é http://localhost:8000/.
Recomendamos o uso do Visual Studio Code (VSCode) para desenvolver o projeto. Para abrir o projeto no VSCode, siga os passos abaixo:
Clique em File > Open Folder... e selecione o diretório do projeto BookHeaded. Certifique-se de que o ambiente virtual esteja ativado no terminal do VSCode.
Nossa equipe irá analisar todos os pull requests. Apenas aqueles que forem coerentes e estiverem alinhados com os objetivos do projeto serão aprovados.
Se tiver qualquer dúvida, sinta-se à vontade para abrir uma issue.
- Para fazer uma boa contribuição siga as boas práticas de codificação em Python, HTML e CSS.
- Formatação correta do código.
- Ordem de imports correta no código.