Quick Start

Let's start making Next.js website themes and plugins and build sites from them!

The easiest way to get started is by using AI to create your theme. If you prefer to to create a theme manually, you can follow this guide.

Create a theme from a prompt

The define and design commands require OPENAI_API_KEY in the project's .env file.

# 1. Create the core files of a theme
npx create-built-app new theme
 
# Follow the CLI commands in the generated theme's README.md file...
 
# 2. Generate sitemap from the theme's description
npx create-built-app define
 
# Review your sitemap...
 
# 3. Create all the theme files based on the sitemap
npx create-built-app design

Create a site from a theme

The site will contain the Sanity schemas and set up data.

You can also export a site from your theme in Built Studio.

# 1. First, publish your theme
npx create-built-app publish
 
# Navigate to the parent directory of the theme project...
cd ..
 
# 2. Create site from theme
npx create-built-app new site "My Awesome Site"
 
# This creates: built-site-my-awesome-site/
 
# Follow the CLI commands in the generated site's README.md file...

If you just want to get a feel for how Built.js works, you can:

Clone a theme

git clone https://github.com/richjava/corporate-shadcn.git

Follow the directions in the project's README to set up and run the theme.

Publish the theme

To be able to use your theme to create sites with, it needs to be published first:

npx create-built-app publish

Create a site

Navigate to the parent directory of the theme project, and run:

npx create-built-app new site "My Awesome Site"
 
# This creates: built-site-my-awesome-site/
 
# Follow the directions in the generated site's README.md file to setup the site...

Alternatively, in Built Studio, select the theme you published, choose the modules for the site, and export the site. You can follow the README to set up and run the site.

Learn more

To familiarize yourself more, check out the Concepts, Guides and the Data Modal Reference.

Quick Start

Create a theme from a prompt

Create a site from a theme

Clone a theme

Publish the theme

Create a site

Learn more

Concepts

Guides

Data Model Reference

On this page