Mapa modular

Módulos: objetivo, uso y razón de existencia

Esta vista explica para qué existe cada módulo, dónde se usa y cómo se relaciona con los demás, con foco en adopción comunitaria.

Si eres directiva

Empieza por web + reportes para controlar ingresos, egresos y rendición mensual.

Si eres operador técnico

Prioriza REST API + dborm para estabilidad, migraciones y observabilidad.

Si quieres colaborar

Comienza en showcase + manual y luego toma issues etiquetados para comunidad.

Módulo

abhackus-rest-api

Objetivo: Exponer capacidades core del negocio (auth, usuarios, contabilidad, reportes, soporte) bajo contratos HTTP claros.

Usos: UI web, TUI, CLI administrativa y automatizaciones operativas.

Módulo

abhackus-dborm/migrations

Objetivo: Versionar y evolucionar el modelo de datos de forma controlada y auditable.

Usos: Provisionamiento de schema, mejoras de integridad y despliegues repetibles.

Módulo

abhackus-web

Objetivo: Operación diaria para usuarios y administradores con enfoque en trazabilidad y productividad.

Usos: Registro de movimientos, aprobaciones, perfil, accesibilidad y configuración institucional.

Módulo

abhackus-showcase

Objetivo: Presentación pública/técnica del proyecto y documentación de alto nivel.

Usos: Onboarding de colaboradores, comunicación del stack y distribución de recursos.

Módulo

abhackus-tui

Objetivo: Interfaz terminal para operación técnica o entornos sin navegador.

Usos: Administración rápida y consultas de estado desde consola.

Módulo

integraciones externas

Objetivo: Conectar notificaciones y automatizaciones sin ampliar innecesariamente la superficie core.

Usos: Telegram/email para alertas operativas y comunicación con comunidad.

Diagrama de contexto

Visión global de actores y módulos principales.

graph TD U[Usuarios] --> W[abhackus-web] A[Admins] --> W O[Operador CLI/TUI] --> T[abhackus-tui] W --> R[abhackus-rest-api] T --> R C[abhackus-admin CLI] --> R R --> P[(PostgreSQL)] R --> N[Telegram/Email] S[abhackus-showcase] --> D[Documentación pública]

Diagrama de despliegue operativo

graph LR subgraph Frontend W[Leptos Web] S[Astro Showcase] end subgraph Backend R[REST API] end subgraph Data P[(PostgreSQL)] M[Migrations] end W --> R R --> P M --> P

Diagrama de secuencia (flujo contable)

sequenceDiagram participant U as Usuario participant W as Web/TUI participant R as REST API participant P as PostgreSQL participant A as Admin U->>W: Registra movimiento W->>R: POST /api/accounting/entries R->>P: INSERT accounting_entry P-->>R: OK R-->>W: entry_id + status A->>W: Revisa pendientes W->>R: POST /api/accounting/entries/:id/approve R->>P: UPDATE status + INSERT audit P-->>R: OK R-->>W: aprobado

Ruta gradual recomendada

Fase 1: habilitar PostgreSQL + migraciones + API saludable.
Fase 2: activar operación web y panel admin para aprobación/auditoría.
Fase 3: abrir contribuciones comunitarias con guía de tests, coverage y revisiones.