Getting Started

Welcome to the WebbiOS Developer Platform! WebbiOS is a powerful open-source platform designed to solve real-world infrastructure challenges. It serves as the core engine powering next-generation business applications, mobile app backends, CRM, and complex ERP systems.

The WebbiOS Architecture

WebbiOS is built from the ground up for the Edge. It consists of four independent pillars that together create the most powerful open-source business growth platform:

1. The Kernel API: The heart of WebbiOS. A headless API gateway running on Cloudflare Edge with D1 database and KV Cache.
2. Universal Dashboard: Your control plane. A ready-to-use admin panel with RBAC, Custom Domains, and Webhooks built-in.
3. Themes: The presentation layer. Load dynamic JSON-based storefronts. Customize everything with our visual Theme Builder.
4. Apps: The extensibility engine. Inject Micro-Frontends directly into your dashboard to expand business logic infinitely.

What can you build?

• Custom Apps: Built as independent Cloudflare Workers using the @webbi/sdk.
• Themes: High-performance storefronts utilizing Edge Rendering and KV Caching.
• Integrations: Connect external ERP, CRM, or shipping providers seamlessly.

Prerequisites

Before diving in, ensure you have the following tools installed:

• Node.js: v20 or higher
• pnpm: We use pnpm as our package manager (npm install -g pnpm)
• Cloudflare Account: To deploy your Workers and Pages
• WebbiOS CLI: @webbi/cli for initializing projects and publishing apps

Next Steps

Now that you understand the big picture, you’re ready to start building:

• Explore the Architecture Overview for a deep dive into the system.
• Check out App Architecture to learn how WebbiOS apps work.
• Head to SDK Installation to install the core libraries.