Skip to content

installation.md

Latest commit

 

History

History
109 lines (78 loc) · 2.24 KB

installation.md

File metadata and controls

109 lines (78 loc) · 2.24 KB
Raw

Instalação

Requisitos

  • Python 3.10+
  • Django 4.2+

Instalação

1. Instalar o pacote

pip install django-govbr-theme

2. Configurar Django

Adicione ao settings.py:

INSTALLED_APPS = [
    # ... suas apps
    'django_govbr_theme',
    # ... outras apps
]

# Templates
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,  # Importante!
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

# Arquivos estáticos
STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'

3. Coletar Arquivos Estáticos

✨ Os assets do GovBR DS já estão incluídos! Não é necessário executar install_govbr_assets. Os arquivos CSS/JS do GovBR Design System já vêm pré-instalados com a biblioteca.

python manage.py collectstatic

Verificação

Crie um template de teste:

<!-- templates/test.html -->
{% extends "govbr/base.html" %}

{% block title %}Teste{% endblock %}

{% block content %}
    <h1>Funcionando!</h1>
{% endblock %}

Atualização Manual dos Assets (Opcional)

Se você quiser atualizar para uma versão mais recente do GovBR Design System antes do lançamento de uma nova versão da biblioteca, pode usar o comando opcional:

python manage.py install_govbr_assets

Requisitos para atualização manual:

  • Node.js e npm (ou yarn)

Opções disponíveis:

# Usar yarn em vez de npm
python manage.py install_govbr_assets --package-manager=yarn

# Pular instalação npm (usar node_modules existente)
python manage.py install_govbr_assets --skip-install

Troubleshooting

Assets não encontrados após collectstatic

# Limpar e recoletar
python manage.py collectstatic --clear

Erros de template

Verifique se 'APP_DIRS': True está configurado no TEMPLATES.

Próximos Passos