Module map

Modules: objective, usage, and reason to exist

This view explains why each module exists, where it is used, and how it connects with others for community-focused operations.

If you are board/admin

Start with web + reports to track income, expenses, and monthly accountability.

If you are technical ops

Prioritize REST API + dborm for stability, migrations, and observability.

If you want to contribute

Begin with showcase + manual and then pick community-tagged issues.

Module

abhackus-rest-api

Objective: Expose core business capabilities (auth, users, accounting, reporting, support) through clear HTTP contracts.

Usage: Web UI, TUI, admin CLI, and operational automations.

Module

abhackus-dborm/migrations

Objective: Version and evolve the data model in a controlled, auditable way.

Usage: Schema provisioning, integrity improvements, and repeatable deployments.

Module

abhackus-web

Objective: Daily operations for users and admins with focus on traceability and productivity.

Usage: Entry registration, approvals, profile, accessibility, and project settings.

Module

abhackus-showcase

Objective: Public/technical presentation of the project and high-level documentation.

Usage: Contributor onboarding, stack communication, and resource distribution.

Module

abhackus-tui

Objective: Terminal UI for technical operations or no-browser environments.

Usage: Fast admin operations and status checks from console.

Module

external integrations

Objective: Connect notifications and automations without expanding core complexity.

Usage: Telegram/email for operational alerts and community communication.

Context diagram

graph TD U[Users] --> W[abhackus-web] A[Admins] --> W O[CLI/TUI Operator] --> 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[Public docs]

Recommended gradual rollout

Phase 1: enable PostgreSQL + migrations + healthy API.
Phase 2: activate web operations and admin approval/audit panel.
Phase 3: open community contributions with test/coverage and review gates.