Template repository for creating Application QBits - complete, self-contained applications or major functional modules for the QQQ framework.
Use this template when building:
- Complete mini-applications (WMS, OMS, CRM)
- Major functional modules with multiple tables
- QBits that require UI navigation (QAppSection)
- Self-contained features with business logic
- Click "Use this template" on GitHub
- Clone your new repository
- Run the customization script:
python scripts/customize_template.py --name my-app --package com.mycompany.qbits.myapp
- Implement your tables, processes, and widgets
- Add your QAppSection for UI navigation
src/main/java/com/kingsrook/qbits/example/
├── ExampleAppQBitConfig.java # Configuration options
├── ExampleAppQBitProducer.java # Entry point, registers QAppSection
├── model/
│ ├── ExampleEntity.java
│ └── ExampleChildEntity.java
├── processes/
│ └── ExampleProcess.java
├── widgets/
│ └── ExampleDashboardWidget.java
└── api/
└── ExampleApiHandler.java
| Feature | Description |
|---|---|
| QAppSection | Required - provides UI navigation |
| Tables | Multiple interconnected business tables |
| Processes | Full CRUD with business logic |
| Widgets | Dashboard components |
| Security | Permission key support |
| Integration | Hooks for other QBits |
- qbit-template-extension - For infrastructure extensions
- qbit-template-data - For reference data providers