Skip to content

Quickstarts

Step-by-step guides that connect a website or app in your framework to CMS Orbit, from an empty project to live preview and refresh on publish.

Explanation2 min read

Pick your framework and follow its guide from an empty project to a working website or app. Each guide shows every file in full and was tested with the versions it names.

Every guide covers the same steps:

  • create the project, install the SDK and add your keys and API address;
  • show every published page at its own address, with not found, redirects, title and description;
  • write components for the blocks editors place, and register them;
  • preview drafts beside the editor, updating as editors type in React and Next.js, and after each save elsewhere;
  • refresh the website when editors publish, through a signed webhook.

The iPhone and Android guides follow the same steps for an app: pages open by their address, components are native views, and content refreshes on pull and when the app comes back. Drafts in an app go through your own server, because the secret key must never ship inside an app.

Start from a working project

Each guide's finished code is a starter on GitHub. Select Use this template, add your keys and run it; the README lists the three steps. The Next.js starters deploy to Vercel with one button, and the Nuxt starter to Vercel or Netlify.

In CMS Orbit, Configuration › Website code does this for your space: it recommends a starter, creates the keys, writes the settings file, fills in the API address and region in the deploy buttons, saves the Preview URL and checks that the website is connected. See Get the website code.

Not on the list?

CMS Orbit works with anything that can make an HTTP request.

  • Another JavaScript framework or another language: The SDK's client needs only fetch, and the delivery API is plain HTTP and JSON. Connect a website without Next.js shows both, with preview and refresh on publish.
  • One request for several things: Read a page, its menu and its banners together with GraphQL.

Was this page helpful?

Read next