Get started with Uniform

Uniform offers a variety of paths for exploring at your own pace. If you're new to Uniform and visual workspaces for composable architectures, the best way to start is to request a demo. Complete the form, pick the date and time that works for you, and the team will walk you through Uniform's composition, personalization, and integration tools.

Prerequisites

You must have access to a Uniform team with the ability to create new projects. If you are an active customer or a partner, please get in touch with your Uniform team administrator colleague and ask for an invite.

If you are not sure or your company does not have a Uniform team, you can request a sandbox here.

Starters#

The fastest way to spin up a new project is with a starter. This is the best for those who learn by doing. With a starter you will:

Use the Uniform CLI to create a new Uniform project
Get a feel of Uniform visual workspace
Experience in-line visual editing
Get to know how personalization and A/B testing works

Each starter automatically connects the local codebase to the Uniform app and comes with live preview and in-line editing enabled.

Hello World Starter

A barebones starter with just the essentials, with two components and one composition. Recommended if you are kicking off a new project and you want the most vanilla working starter based on Next.js

Component Starter Kit

Get started with a more full-featured starter kit that contains 30+ of modern, theme-able components.

Next.js (App Router) tutorial

Pick from one of 3 options to kick start your app router project.

Open sourced examples#

In addition to the starters above, Uniform offers more open-sourced examples on GitHub. These include starters for Algolia, Gatsby5, Sitecore, as well as edge-side personalization with various CDNs.

Uniform visual workspace tutorials#

If you would like to learn how to enable full visual in-line editing for your modern web application, connect it with any headless CMS or commerce back-end, and leverage edge personalization and A/B testing, these tutorials are for you.

Next.js App Router

Next.js app built with App Router.

Next.js Page Router

Next.js app built with Page Router.

Nuxt tutorial

A composable app with Nuxt 3.

Custom mesh app

If you build a new integration for Uniform or extend Uniform UI

Personalization + Headless CMS tutorials#

If you're looking to only enable personalization inside your Headless CMS, consider the following tutorials. These tutorials allow using Uniform Context capability without Uniform Canvas. This may be relevant if you are looking for incremental adoption of Uniform and you are looking to add personalization as step 1 into your existing Headless CMS.

For greenfield projects

If you are planning a new project that involves a Headless CMS, Uniform recommends following complete Visual Workspace tutorials above.

On this page