create-qlik
v3.0.0
Published
[![npm version](https://badge.fury.io/js/create-qlik.svg)](https://badge.fury.io/js/create-qlik)
Downloads
73
Maintainers
Readme
Create Qlik module
A flexible npm package for building web app templates, mashups, and extensions for Qlik Sense using React. This implies that the process of developing these Qlik Sense utilities is straightforward and quick, providing users with the anticipated efficient and effective experience.
Features
- Streamlines the creation of Qlik Sense projects using React.
- Supports extensions, mashups, and standalone web apps.
- Provides a well-structured foundation for development.
- Offers hot reloading for efficient workflows.
Installation
npm install -g create-qlik
Follow the prompts to choose between creating a Qlik Sense extension, mashup, or web app template.
Usage
Create Qlik Sense Extension
npm create qlik@latest
# Choose 'extension' option
cd your-extension-folder
npm install
# Update .env file and shared folder path
npm start
# To build and upload extension to QMC
npm run extension
Create Qlik Sense Mashup
npm create qlik@latest
# Choose 'mashup' option
cd your-mashup-folder
npm install
# Update .env file and configure virtual proxy
npm run dev
# To build and import mashup into QMC
npm run build
Create Qlik Sense Cloud Web App
npm create qlik@latest
# Choose 'web app' option
cd your-web-app-folder
npm install
# Update .env file
npm run dev
Configuration
- For extensions: Update .env file to shared folder path.
- For mashups: Update the .env file with host, port, prefix, isSecure, appid, and objects information, and configure the virtual proxy
- For web apps: Update the .env file with host, port, prefix, isSecure, integration id, appid, and objects information, and configure the virtual proxy
Development and Deployment
Extension:
- Build:
npm start
- Run development server:
npm run extension
Mashup
- Run development server:
npm run dev
- Build:
npm run build
Webapp:
- Run development server:
npm run dev
Contributing
We welcome contributions! Please refer to the Portfolio
License
This project is licensed under the MIT License.