Getting Started

Introduction

Welcome to Super Qi Miniapps - Your gateway to building lightweight, powerful applications.

Welcome to Super Qi Miniapps Docs

Welcome to the Super Qi Miniapps documentation! This guide will help you build, develop, and deploy powerful lightweight applications that run seamlessly within the Super Qi ecosystem.

Whether you're building your first Miniapp or you're an experienced developer looking to leverage Super Qi's platform, this documentation provides everything you need to succeed.

About This Documentation

This documentation is organized into two main sections designed to support you throughout your development journey:

The Developers Guide is your comprehensive, step-by-step companion that walks you through taking your Miniapp from scratch to production. This section provides a complete journey covering every aspect of development:

Getting Started - Understanding Miniapps, their lifecycle, and choosing your development approach
Configuration & Setup - Setting up your development environment, understanding Super Qi platforms, and configuring UAT access
Creating Your First Miniapp - Building a functional Miniapp from scratch, including configuration and testing
Demo Miniapp - Exploring a complete example application with detailed frontend and backend code walkthroughs
Releasing to Production - Completing security review, merchant registration, and deploying your Miniapp to production

Follow the Developers Guide ThoroughlyStart with the Developers Guide if you're new to Super Qi Miniapps. It provides a structured learning path that takes you from your first Miniapp to production deployment. Please follow it thoroughly - each section builds upon the previous one, ensuring you have all the knowledge and setup needed before moving to production. Skipping steps may lead to issues later in your development process.

2. API Reference

The API Reference is your comprehensive technical reference for all Super Qi APIs, flows, and integration details. Use this section when you need:

Flows - End-to-end integration guides for authentication and payments
Open APIs - Backend-to-backend API specifications and request/response details
JSAPIs - Client-side JavaScript APIs for accessing platform features

The API Reference is designed for quick lookup and detailed technical specifications. Bookmark specific APIs you use frequently for easy access.

What You'll Need

Before you start, make sure you have the following ready — missing any of these can block you partway through the journey:

Accounts & Access

A Super Qi Console account (created in Super Qi Platforms).

Hardware

A physical phone (Android or iOS) to install and test your Miniapp.
Your phone and development machine must reach the same network during local testing.

Development Tools (for the demo Miniapp and local backend)

Git and Node.js v18+ (includes npm)
Go v1.21+ — only if you use the Go backend

Detailed install steps are covered in Installation Steps.

Miniapp Development Types

Super Qi supports two distinct approaches to building Miniapps, each with its own advantages. Choose the one that best fits your team's skills and project requirements:

DSL (Domain-Specific Language)

DSL is Super Qi's custom development framework forked from JavaScript, specifically designed for Miniapp development.

Key Features:

Optimized Performance - Built specifically for Miniapps with minimal overhead
Native-like Experience - Provides smooth, app-like user interactions
Structured Framework - Opinionated architecture that promotes best practices

Best For:

Developers who want the best performance and native feel
Teams building feature-rich, complex Miniapps

Development Stack:

DSL (JavaScript-based syntax)
Native APIs and services

H5+ (Open Web Development)

H5+ brings the familiar web development stack to Miniapps, allowing you to use standard web technologies.

Key Features:

Web Standards - Build with HTML5, JavaScript, and TypeScript
Familiar Tools - Use your existing web development skills and tools
Rapid Development - Leverage existing web libraries and frameworks
Cross-Platform - Code can be more easily shared with web applications

Best For:

Web developers transitioning to Miniapps
Projects with existing web codebases
Teams prioritizing development speed and familiarity
Simpler applications with standard web interactions

Development Stack:

HTML5
JavaScript / TypeScript
CSS3
Web APIs

Keep in mind that in the following docs, we will be going through H5+ and its our recommended approach so far, DSL Docs will be added later on in the future, but if you are interested, Check it out here

Both DSL and H5+ Miniapps have access to the same Super Qi platform features, including authentication, payments, and user data. The choice between them is primarily about developer experience and performance requirements.

AI Integration

Get help from AI tools while developing your Super Qi Miniapps. Our documentation is optimized for use with ChatGPT, Claude, and other AI assistants.

Learn more about using AI with Super Qi documentation.

Getting Help

Throughout your development journey, you'll have access to:

This Documentation - Comprehensive guides and API references
Miniapp Demo - ready implemented demo app that shows the features available
Developer Portal - Account management and app submission
Technical Support - Technical assistance when you need it by contacting the Miniapp team

Let's build something amazing together! Start your journey by learning What are Miniapps in the next section.

What Are Miniapps

Understanding Super Qi Miniapps architecture, capabilities, and platform features.