Getting Started

This is the entry point for everyone building on or integrating with revenexx Revenue Cloud — a multi-tenant B2B commerce platform. Whether you're writing a custom app, automating an ERP sync, or building a storefront, the pages in this section give you the mental model and the practical steps to get going.

Who this documentation is for

The Developer Portal is written for the people who build with revenexx — not the merchants who use it day-to-day. If one of these descriptions sounds like you, you're in the right place:

• Backend developers writing custom apps that ship as cloud functions and extend the platform's business logic (orders, pricing, customer segments, …).
• Frontend developers building customer-facing storefronts on Nuxt 4, either composing pages visually with Blökkli or going fully custom against the platform APIs.
• Integration engineers connecting customers' enterprise systems (SAP, Salesforce, Salsify, …) to revenexx using visual workflows — no glue code.
• Solution architects and partners evaluating the platform, planning an integration project, or scoping a custom commerce build for an end customer.

End customers (the merchants running their business in Cockpit) and their buyers (the people placing orders in storefronts) are not the audience here. They have separate, task-oriented documentation in Cockpit itself.

How to read this section

The pages below build on each other. If you're new, read them in order — each takes 5–10 minutes:

1. Platform Overview — Start here. What revenexx Revenue Cloud is, who uses it, the six Studios that make up the product, and the kinds of things you can build. Read this first, even if you came looking for code.
2. Concepts — The concept model: how Cockpit, the Studios, apps, sites, the Marketplace and the data core relate, and which piece you touch for which kind of work.
3. Architecture Overview — How the platform fits together: the layers you build on, how each tenant's data stays isolated, and how a request flows from the storefront to the data and back.
4. Apps and Sites — Business logic lives in an App, the front end in a Theme. What belongs where, and how the two connect.
5. Frontend stacks — Which stacks build on the platform today (Nuxt 4 for storefronts; no PHP), whether a single-page app is required, and what skills a storefront team needs. Read this before you staff a project.
6. Bring an existing frontend — Moving from Shopware, Magento or a custom shop: what carries over, what is rebuilt, and how a migration is scoped. There is no automated migration tool.
7. Prerequisites — A short checklist of the account and tools you need before you can run the Quick Start.
8. Quick Start — Hands-on: install the CLI, sign in, scaffold an app, and deploy it live. ~15 minutes.
9. Glossary — Reference: every domain term used across the docs (Tenant, App, Cockpit, Studio, Manifest, …). Skim once, come back when something doesn't click.
10. Get Help — Where a developer question goes, what to include so it can be answered in one round trip, and how to report a problem with a docs page.

All the way through — the orientation pages, then the Quick Start — budget about an hour from landing here to a deployed app, with an account already in hand. Signing up has its own lead time and is not part of that hour; Prerequisites says what to expect.

After Getting Started, branch into one of the product areas based on what you're building:

• Writing an app? → Build an App
• Building a storefront? → Build a storefront
• Replacing an existing shop? → Bring an existing frontend
• Connecting an ERP, PIM or CRM? → Connect a system
• Calling the API from your own code? → Call the API directly

Each path states what you need before you start and the first command to run.

In one sentence

revenexx Revenue Cloud lets you build, integrate, and operate B2B commerce systems — without writing the same multi-tenancy, identity, and workflow plumbing that every commerce project rebuilds from scratch. The next page explains what that means in practice.