For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign in
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • Get started
    • Quickstart
    • Concepts
  • Guides
    • Environments
  • Reference
    • Product docs
    • Blog
    • Support
Sign in
LogoLogo
On this page
  • Requirements
  • Automatic setup
Get started

Quickstart

Was this page helpful?
Next

App Router

Built with

We recommend using the automatic setup to explore Makeswift in a fresh Next.js app. If you have an existing Next.js app, you can use the manual installation guide.

Requirements

You will need the following:

  • Node.js 20.19 or a later version.
  • macOS, Windows (including WSL), and Linux are supported.
  • Familiarity with Next.js.

You don’t need an existing Makeswift account to get started with this guide.

Automatic setup

1

Initialize the app

Perform the following CLI command.

$npx makeswift@latest init

After you confirm, the CLI will create a new Next.js app in a directory with the project’s name.

The CLI then opens a new page in your browser where you will continue integrating your app.

2

Connect the Next.js app to a Makeswift site

The browser will prompt you to select a Makeswift site to connect to your local Next.js app. You may need to login or sign up, but the browser will redirect you to this page.

Select an existing site or create a new one.
Screenshot of select site to integrate
Pick a template (optional).
Screenshot of template picker
Check CLI while site is being linked.
Screenshot of linking page

During this step, the Makeswift site API Key is stored as an environment variable inside your local .env.local file.

Make sure to check your console during the linking process. If the CLI fails to install dependencies you may need to install them manually.

3

Start building

The browser redirects you to the Makeswift Visual Builder once the integration is complete. If you skipped the template option, make sure to create a page.

How do I create a page?
Screenshot of add page

You should find some new custom components in the toolbar.

Screenshot of custom components in toolbar

These components will be located in the components folder of your Next.js app. You can explore the files ending with .makeswift.ts to learn more about registering components.

To learn how to use Makeswift builder, see the Help Center articles.