Segue a baixo um guia para iniciar o projeto.

Primeiro crie um ambiente virtual utilizando o venv.

python -m venv venv

Logo depois, acesse a pasta do ambiente pelo terminal e ative o arquivo "activate.bat".

venv\Scripts\activate

No caso do Linux.

venv\bin\activate

Instalando as dependências do projeto.

Use o gerenciador de pacotes do python para baixar as as bibliotecas necessárias do arquivo requirements.txt.

pip install -r requirements.txt

Configuração de Variáveis de Ambiente com dotenv

Crie um arquivo .env na raiz do projeto. Este arquivo deve conter todas as variáveis de ambiente necessárias para a aplicação funcionar corretamente. Aqui está um exemplo de como o arquivo .env pode ser estruturado:

DJANGO_SECRET_KEY=sua-chave-secreta-aqui
DEBUG=True

Não compartilhe seu arquivo .env ou qualquer informação sensível contida nele. Essas variáveis devem ser mantidas em segredo e não devem ser incluídas no controle de versão.

Este projeto utiliza o python-dotenv para gerenciar variáveis de ambiente de maneira segura.

Migração do Banco de dados

Será necessário fazer uma migração no nosso banco de dados executando o seguinte comando:

python manage.py migrate

Executando o projeto localmente.

Após abrir a pasta raiz do projeto (onde está o arquivo manage.py), com suas devidas dependências instaladas e dentro de um ambiente virtual (de preferência), execute o comando abaixo no terminal.

python manage.py runserver

Isso irá rodar o projeto em um servidor local, caso uma janela do navegador não se inicie sozinha, clique no link gerado no terminal.

Contribuições

Pull Requests são bem-vindos.