Getting Started with SuperApp
Welcome! This guide will help you get started with the SuperApp platform based on your role.
Choose Your Path
Select the role that best describes what you want to do:
-
SuperApp Platform Deployer
You're setting up and deploying the complete SuperApp infrastructure for your organization.
Your responsibilities:
- Deploy backend services (Core & Token Service)
- Set up databases and infrastructure
- Configure external authentication providers
- Build and deploy the mobile application
- Monitor system health and performance
Start here:
Next:- Architecture Overview - Understand the system
- Core Service Guide - Main API service
- Token Service Guide - Internal OAuth2/JWT service
- Mobile App Guide - Mobile app setup
- Observability - Monitoring setup
- Pluggable Backend Services - Custom File and User Management Services
- Bridge Guide - Bridge Overview
-
MicroApp Developer
You're building web applications that will run inside the SuperApp container.
Your responsibilities:
- Develop web apps using your preferred framework
- Integrate with SuperApp via the Bridge API
- Access native device features
- Package and publish your micro-apps
- Handle authentication and authorization
Start here:
Next:- Bridge API Reference - Native feature access
- Push Notifications - Send notifications to users
- Sample MicroApps
-
Platform Administrator
You're managing the SuperApp platform, users, and micro-apps through the admin portal.
Your responsibilities:
- Manage micro-app catalog and versions
- Upload and publish micro-apps
- Create OAuth clients for micro-app backends
- Manage user access and permissions
- Configure platform settings
Start here:
Need Help?
Not sure which path to choose?
- Want to set up the platform? → Start with SuperApp Platform Deployer
- Want to build apps for the platform? → Start with MicroApp Developer
- Want to manage the platform? → Start with Platform Administrator
Additional Resources
- GitHub Repository - Source code and issues
- Architecture Overview - System design and components
- API Reference - Complete API documentation
- Full Documentation - Back to documentation home