@kaizentech/wizard-sdk
v1.0.41
Published
KLP Wizard SDK - CDN üzerinden embed edilebilir frontend script
Readme
🧙 KLP Wizard SDK
A lightweight and modern frontend SDK that can be embedded via CDN. Provides an interactive wizard modal with features such as campaigns, rewards, FAQ, and recent activities.
📋 Table of Contents
✨ Features
- 🎯 CDN Integration: Easy integration with a single script tag
- 🎨 Modern UI: Sleek and modern interface with Inter font
- 📱 Responsive: Perfect appearance on all devices
- 🔄 SPA Support: Automatic remount in Single Page Applications
- 🎭 Multiple Pages: Welcome, Demo, Campaigns, Rewards, FAQ, and Last Activities pages
- 🔐 Authentication: Flexible auth configuration
- 🎨 Customizable: Font and appearance settings
- 📊 Event Tracking: Automatic event push support
📦 Installation
Install via NPM
# Latest (stable) version
npm install @kaizentech/wizard-sdk
# Beta version
npm install @kaizentech/wizard-sdk@betaUsing CDN
<script
defer
src="https://unpkg.com/@kaizentech/wizard-sdk/dist/klp-wizard.min.js"
api-key="YOUR_API_KEY"
></script>🚀 Quick Start
- Add Script Tag
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>My Website</title>
</head>
<body>
<!-- KLP Wizard SDK -->
<script
defer
src="https://unpkg.com/@kaizentech/wizard-sdk/dist/klp-wizard.min.js"
api-key="YOUR_API_KEY"
></script>
</body>
</html>- Get Your API Key
You can get your API key from the Revx management panel.
- Ready!
After the script loads, a floating action button will automatically appear in the bottom right corner of your page.
🔧 Technologies
- ESBuild: Fast JavaScript bundler
- Axios: For HTTP requests
- JavaScript Obfuscator: Code obfuscation in production builds
📝 Notes
SPA (Single Page Application) Support
The SDK works automatically in SPAs. It monitors History API changes (pushState, replaceState, popstate) and automatically remounts the modal and floating button.
Font Management
The SDK uses Inter font by default. Different fonts can be selected through configuration:
- Inter (default)
- Roboto
- Open Sans
- Lato
- Montserrat
- Poppins
- Oswald
- Merriweather
- Raleway
- Playfair Display
Event Tracking
The SDK automatically performs event tracking. Events are pushed to the backend and can be viewed in the console when debug mode is enabled.
👤 Author
⭐ If you liked this project, don't forget to give it a star!
