Esse é um template de projeto Django com DRF, PDM e muito mais. Ele já vem com algumas configurações e pacotes pré-instalados, como o PDM, Django, Django REST Framework, PostgreSQL, SQLite, Swagger, [Black](), [isort](), [Fl0](), [Cloudinary](), [Corsheaders](), [Django-Extensions](), [Django-Filter](), [dotenv](), [drf-spectacular](), [gunicon](), [netifaces](), [rest-framework-simplejwt]() e [whitenoise]().
Esse template já está pronto para ser utilizado em produção, com o Fl0 e o PostgreSQL. Mas também pode ser utilizado em desenvolvimento, com o PDM e o SQLite.
O template também já vem com alguns arquivos de configuração pré-configurados, como:
pyproject.toml
: Arquivo de configuração do PDM.Procfile
: Arquivo de configuração do Fl0.settings.py
: Arquivo de configuração do Django.urls.py
: Arquivo de configuração das rotas do Django.wsgi.py
: Arquivo de configuração do Gunicorn..env.exemplo
: Arquivo de exemplo de configuração das variáveis de ambiente..gitignore
: Arquivo de configuração do Git, para ignorar arquivos e diretórios.O template também traz o usuário padrão modificado, com o login sendo feito com o e-mail
e não com o username
. Inclusões de campos, como telefone
, data de nascimento
e foto de perfil
, podem ser feitas facilmente.
Certifique-se de ter o Python instalado em seu sistema.
Crie um novo projeto a partir desse template:
Use this template
em Create a new repository
.Owner
: <seu usuário no GitHub>Repository name
: livraria
Create repository
.Abra o projeto no vscode e execute o terminal.
Crie um ambiente virtual usando o PDM:
pdm install
Crie o arquivo .env, a partir do arquivo .env.exemplo, e configure as variáveis de ambiente:
cp .env.exemplo .env
Execute o servidor de desenvolvimento:
pdm run dev
Acesse a API em http://localhost:19003/api/
A documentação completa dos endpoints da API e exemplos de uso estão disponíveis na Documentação da API.
pdm run dev
: Executa o servidor de desenvolvimento. Antes de executar o servidor, descobre o endereço IP da máquina e atualiza o arquivo .env
com o endereço IP.pdm run migrate
: Executa as migrações do banco de dados. Antes de executar o migrate
, executa o makemigrations
. Depois de executar o migrate
, executa o graph_models
, atualizando o diagrama de classes dos modelos do projeto.Esse projeto utiliza os seguintes pacotes e tecnologias:
shell_plus
, que permite acessar o shell do Django com todos os modelos importados e o comando graph_models
, que gera um diagrama de classes dos modelos do projeto..env
.Este projeto está licenciado sob a Licença GPL, uma licença de software livre.