Analytics Notebook

A Svelte web application for searching and exploring Qlik Cloud analytics content. Connect to your Qlik Cloud tenant to search across dimensions, measures, and expressions in all your applications.

Features

• Qlik Cloud OAuth Authentication — Securely connect to Qlik Cloud tenants via OAuth2
• Fuzzy Search — Search through master dimensions, master measures, sheet dimensions, and sheet measures
• Multi-App Support — Browse and search across multiple Qlik applications simultaneously
• Filtering — Filter results by space, app, sheet, object type, or sheet state (Public/Community/Private)
• Favorites — Star and save favorite dimensions and measures for quick access
• Excel Export — Export search results to XLSX format
• Dark Mode — Supports light and dark themes
• Responsive — Works on desktop and mobile devices
• Secure - No data leaves your browser

Tech Stack

• Svelte 5 with SvelteKit
• TypeScript
• Tailwind CSS 4
• IndexedDB for efficient client-side search and data storage
• SheetJS (xlsx) for Excel export
• @qlik/api for Qlik Cloud connectivity
• Vitest for testing

Getting Started

Prerequisites

• Node.js 22+
• A Qlik Cloud tenant (US or EU region, unless you add additional OAuth clients)

Installation

# Clone the repository
git clone https://github.com/sm-qlik/analytics-notebook-svelte.git
cd analytics-notebook-svelte

# Install dependencies
npm install

Development

Start the development server:

npm run dev

Open http://localhost:3000 in your browser.

Building for Production

Create a production build:

npm run build

Preview the production build locally:

npm run preview

Deployment

The app is configured for static deployment (e.g., GitHub Pages).

Deploy to GitHub Pages:

npm run publish

This runs npm run build followed by npm run deploy, which uses gh-pages to publish the build directory.

Usage

1. Enter your Qlik Cloud tenant URL — e.g., your-tenant.us.qlikcloud.com or your-tenant.eu.qlikcloud.com
2. Authenticate — You'll be redirected to Qlik Cloud for OAuth authentication
3. Search — Once authenticated, apps will load automatically. Use the search bar to find dimensions and measures
4. Filter — Use the sidebar to filter by space, app, sheet, object type, or sheet state. Use the type filter chips to filter by Master Dimension, Master Measure, Sheet Dimension, or Sheet Measure
5. Favorites — Click the star icon on any result to add it to your favorites. Use the "Favorites" filter button to show only favorited items
6. Export — Click the export button to download results as an Excel file

Available Scripts

Project Structure

src/
├── lib/
│   ├── assets/           # Static assets (favicon, logos, images)
│   ├── components/       # Svelte UI components (search, filters, displays, indicators)
│   ├── stores/           # Svelte stores for state management (authentication)
│   ├── utils/            # Utility functions (Qlik auth, engine API, table helpers)
│   └── index.ts          # Library exports
├── routes/               # SvelteKit routes (pages, layouts, OAuth callback)
└── app.*                 # App configuration files (CSS, TypeScript types, HTML template)