How hexya-addons/base works
Project type and purpose
• This is a Go-based “kernel” library for Hexya (an ERP-style framework). It provides the foundational data models, services (cron, queue, security, sequence), resource definitions (XML), seed/demo data (CSV), static assets, and internationalization (PO files).
File structure
• Top-level Go files: individual modules (bank.go, company.go, user.go, etc.)
• Directories:
• basetypes: core Go types
• i18n: translation PO files
• data & demo: CSV seed/demo data
• resources: XML view/menu/field definitions
• static: web assets
• tests alongside each module
• Config/build: go.mod, .travis.yml, run_tests.sh
Key insights from README
• “The kernel of Hexya, needed for all installation”
• No external microservices—everything is packaged as a Go library that plugs into the Hexya runtime.
Main components
A. Go Kernel (library)
• Sub-components (packages/modules):
• basetypes
• model mixins (image_mixin, model_mixin, translation)
• business modules (bank, company, country, partner, user, group, currency)
• services (cron, queue, security, sequence, attachment)
B. Data Loaders
• CSV Loader: data/ & demo/ → database seed
• XML Resource Loader: resources/ → UI metadata & menus
• i18n Loader: i18n/*.po → translation tables
C. Database
• Stores all model tables, sequences, queue jobs, cron schedules
D. Runtime Services
• Cron Scheduler
• Queue Worker
• Sequence Generator
E. Web UI Layer
• Serves metadata-driven UI based on loaded XML resources
• Serves static assets (static/src/img, description)
F. CLI/Test Runner
• run_tests.sh, go test integration
Relationships and interactions
• On startup, the Kernel:
1. Registers all Go modules (models + services) with the Hexya core.
2. Loads XML resources → builds UI metadata.
3. Loads CSV seed/demo data → populates DB.
4. Loads PO files → populates translation tables.
• At runtime:
• Web requests → Web UI Layer → Model API → DB
• Cron Scheduler → triggers module cron functions → writes to DB or queue
• Queue Worker → processes queued tasks via module handlers
• Sequence Generator → ensures unique IDs for models
Architectural patterns & design principles
• Modular plugin architecture: each .go file is a self-contained module
• Metadata-driven UI: XML resources describe views and menus
• Separation of concerns:
• Data definitions (Go structs + CSV)
• UI definitions (XML resources)
• Translations (PO)
• Static web assets
• Background services (cron / queue)