Overview
Every ARI module follows a consistent structure. This makes modules predictable, easy to understand, and simple to share with others.
What a Module Contains
A module is a self-contained unit that can include any combination of:
- Pages — Full page support within the ARI workspace
- API Routes — Dedicated endpoints for the module's data operations
- Database Tables — Module-specific tables with row-level security
- Dashboard Widgets — Optional cards on the main ARI dashboard
- Settings — Per-module configuration options
- Navigation — Automatic sidebar integration
Module Manifest
Each module has a manifest file that defines its metadata: name, description, version, icon, display priority, and layout mode.
The manifest tells ARI how to register the module in the sidebar, whether it should appear on the dashboard, and how it should be laid out.
Layout Options
Modules support two layout modes:
- Standard — Renders within the ARI sidebar layout. Best for most modules like Task Manager, Contacts, and Knowledge Manager.
- Fullscreen — Takes the entire viewport. Best for immersive experiences like games, canvases, or visualization tools like Task Monsters.
Auto-Discovery
ARI automatically discovers modules in the modules directory. Drop a module folder in, and it is immediately available in your sidebar and routing. No manual registration required.
Sharing Modules
Because modules are self-contained directories with a consistent structure, they are easy to share. You can copy a module folder to another ARI instance, share it with the community, or fork an existing module and customize it.
See Creating Modules for how to build your own.