Guia do Desenvolvedor

Bem-vindo à documentação técnica do hyms-plat!

Visão Geral

O hyms-plat é um portal Django/Wagtail para hinários do Santo Daime com:

• Busca avançada via TypeSense
• CMS Wagtail para páginas
• Upload de áudio (em desenvolvimento)
• Features sociais
• Docker para serviços externos

Stack Tecnológico

Componente	Tecnologia
Backend	Django 5.1 + Python 3.11+
CMS	Wagtail 6.4
Banco de Dados	PostgreSQL 16
Busca	TypeSense 27.1
Task Queue	Celery + Redis
Testes	pytest (290+ testes, 83%+ coverage)

Veja detalhes em Technology Stack.

Começando

• Setup Local

  ---

  Configure seu ambiente de desenvolvimento

• Arquitetura

  ---

  Entenda a estrutura do sistema

• Contribuindo

  ---

  Como contribuir com o projeto

• Testes

  ---

  Estratégia de testes do projeto

Links Rápidos

Referência

• Models Reference
• Views Reference
• Management Commands
• TypeSense Client

Guias

• Importar YAML
• Reindexar Busca
• Adicionar Features

Deploy

• Visão Geral
• CI/CD

Status do Projeto

Fase	Status	Cobertura
Fase 0: Setup	Completa	N/A
Fase 1: MVP Read-Only	Completa	98%
Fase 2: Upload & Users	Completa	85%
Fase 3: Áudio & Social	Completa	83%
Fase 4: Deploy & Prod	Em andamento	-

Veja o Roadmap completo.

Estrutura do Projeto

hyms-plat/
├── apps/                    # Django apps
│   ├── core/               # Base e utilidades
│   ├── hymns/              # Hinários e hinos
│   ├── search/             # TypeSense integration
│   ├── users/              # Autenticação e perfis
│   └── cms/                # Wagtail CMS
├── config/                  # Configurações Django
│   └── settings/           # Settings por ambiente
├── templates/              # Templates HTML
├── static/                 # Arquivos estáticos
├── tests/                  # Testes
│   ├── unit/              # Testes unitários
│   └── e2e/               # Testes E2E (Playwright)
└── docs/                   # Esta documentação