Skip to content

Template repository for creating QQQ Application QBits - complete mini-apps with tables, processes, and widgets

Notifications You must be signed in to change notification settings

QRun-IO/qbit-template-application

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

QBit Template - Application

Template repository for creating Application QBits - complete, self-contained applications or major functional modules for the QQQ framework.

When to Use This Template

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

Quick Start

  1. Click "Use this template" on GitHub
  2. Clone your new repository
  3. Run the customization script:
    python scripts/customize_template.py --name my-app --package com.mycompany.qbits.myapp
  4. Implement your tables, processes, and widgets
  5. Add your QAppSection for UI navigation

Structure

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

Key Characteristics

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

Documentation

See Also

About

Template repository for creating QQQ Application QBits - complete mini-apps with tables, processes, and widgets

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages