django-nexum-base 0.0.3

Back-end Boilerplate Modular

Django Nexum Base

Descrição

Boilerplate modular para construção de sites Standard, feito em Django e Django REST Framework. Permite criar projetos robustos e escaláveis rapidamente, com autenticação JWT, 2FA, permissões, API RESTful e integração de email.

Ambiente virtual

Antes de instalar, crie e ative um ambiente virtual Python:

python -m venv venv
source venv/bin/activate  # Linux/macOS
venv\Scripts\activate     # Windows

Configuração Inicial do Django

Se ainda não possui um projeto Django, crie um novo projeto e um app:

django-admin startproject project_name
cd meu_projeto
python manage.py startapp app_name

Instalação

pip install django-nexum-base

Setup

Adicione base, rest_framework e django_filters ao seu INSTALLED_APPS no settings.py:

INSTALLED_APPS = [
    ...
    'rest_framework',
    'django_filters',
    'base',
]

Configure o usuário customizado:

AUTH_USER_MODEL = 'base.BaseCustomUser'

Rode as migrações:

python manage.py makemigrations

e em seguida:

python manage.py migrate

Exemplo de Uso:

Criando um produto

from base.models import BaseProduct

produto = BaseProduct.objects.create( name="Produto Exemplo", price=99.99, stock=100 )

Envie email (exemplo):

```python
from base.utils import send_otp_email
send_otp_email(user)

Documentação

Consulte a documentação completa dos endpoints, modelos e exemplos de uso no repositório ou no diretório docs/.

Licença

MIT