QS-Ext-Jump-Start

A Qlik Sense extension template built on Nebula.js. Includes a working selections example, Playwright E2E tests, GitHub Actions CI, and documentation to start building from.

Quick Start

1. Click "Use this template" on GitHub to create your repository
2. Clone your new repository and open it in your AI agent
3. Initialize your project by telling your AI agent:

   Load context from './.ai-toolbox/context.global.md' then use initialize command for this project: "[YOUR_PROJECT_NAME]"; description: "[YOUR_PROJECT_DESCRIPTION]"
   

   This workflow configures your extension name, sets up your local preferences, applies your identity to configuration files, removes template-only artifacts, and removes template development context.
4. Install dependencies: npm install
5. Set up your Qlik environment: Qlik Cloud · Enterprise
6. Start the development server: npm run serve

What's Included

	Feature	Description
✅	Nebula.js extension	Stardust hooks architecture with component-based rendering
✅	Selections example	Dimension/measure table with full useSelections lifecycle
✅	State management	WeakMap-based state isolation (src/state/)
✅	E2E tests	Playwright suite against a live Nebula Hub environment
✅	GitHub Actions CI	Lint, Build, and Package checks on every PR
✅	Development server	Hot reload via Nebula CLI

Development

npm run serve     # start dev server at localhost:8000
npm run lint      # lint src/ and test/
npm run build     # build to dist/
npm run package   # package for Qlik deployment
npm test          # run E2E tests (requires live Qlik environment — see docs)

See Project Structure for a map of all source files.

Environment Setup

The development server and tests require a live Qlik Sense environment. Configure .env before running npm test.

• Qlik Cloud Setup
• Enterprise Setup

Documentation

Guide	Purpose
Workflows & Tasks	Common tasks: rename, customize, deploy
Testing Guide	Test setup, running, and troubleshooting
Project Structure	File layout and architecture
Deployment	Packaging and uploading to Qlik
Changelog	Version history

Contributing

To contribute to this template, see CONTRIBUTING.md.

License

MIT — see license.txt