Get started

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 don't already have one, you can request access here: https://uniform.dev/try.

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 how Uniform Visual Workspace works
  • Experience visual in-line editing

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

Next.js (App Router) tutorial

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

Component Starter Kit

A set of modern, theme-able components to learn about Uniform the quickest way possible.

Hello World Starter

A plain starter with just the essentials, with two components and one composition.

Commerce Starter

A modern e-commerce site with a product catalog, cart functionality, and personalization. Available on GitHub.

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.

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

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, we recommend following complete Visual Workspace tutorials above.

Contentful + Personalization

Learn how to add personalization to Contentful.

Contentstack + Personalization

Learn how to add personalization to Contentstack.

Kontent.ai + Personalization

Learn how to add personalization to Kontent.ai.

Sanity + Personalization

Learn how to add personalization to Sanity Studio

The Uniform.app supports all modern web browsers. We commit to supporting the two most recent versions of the following browsers:

  • Google Chrome
  • Mozilla Firefox
  • Apple Safari
  • Microsoft Edge

Although we only commit to supporting the two most recent versions, we continue to support the prior version for an additional six months following the release of a new version. Usually, older versions of Uniform should also be able to run, although functionality may be compromised. Users can check here to determine whether they're using the most recent version.

Last modified