Made in Builder.io

Join us for the biggest Figma-to-code launch of the year

Builder.io logo
Talk to Us
Platform
Developers
Talk to Us

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

This Quickstart shows how to integrate page building with Builder.io in a brief format. We recommend this as the best way to get started with the Builder platform.

Tip: This Quickstart moves at a fast pace to get you up and going as quickly as possible, so it assumes development proficiency and workflow familiarity. For more detailed, step-by-step instructions, see Integrating Pages.

To get the most out of this guide, you should have:

  • A working app in the framework of your choice. Create an app if you don't already have one.
  • A basic understanding of development including the command line, npm, and code for your framework.
  • A Builder Space.

Tip: On Windows, be sure to use quoting when you install dependencies that use the @ operator; for example, npm install "@builder.io/react".

  1. Go to the Models section in Builder and choose your Page model.
  2. Set the Preview URL to http://localhost:YOUR_PORT where YOUR_PORT is the port number for your app. Be sure to include the http://.
  3. Click Save.
  4. In the Content section of Builder, create a new blank Page and name it something like Test Page.
  5. Add some minimal content, such as a Text block with some copy such as "I did it!".
  6. Click the Publish button.
  7. Go to http://localhost:3000/test-page, where test-page is the name you gave your page, and check out your work. Well done!

The next video shows this process, including getting your API Key as described in the last section:

Depending on the framework, the path and port can vary. Check your framework according to the below:

Frameworklocalhost URL

Angular

http://localhost:4200

Gatsby

http://localhost:3000

Qwik

http://localhost:5173

Remix

http://localhost:3000

If you're getting a 404 but aren't sure why, check these things:

  • Make sure you've published your page in Builder by clicking the Publish button on the upper right corner.
  • Check the URL. If you name the page test2 for example, Builder adds a hyphen, so that the URL segment is test-2.

For a community example with Builder and Next.js that includes ISR capabilities and SEO optimizations, see Kenzitron's Builder.IO & NextJs starter with ISR & SEO optimization on GitHub.

With your app and Builder working together, the next step is the fun part–add some pages in Builder and drag in some elements. Play with styles and explore the UI.

Use your custom components in Builder

To use your own components in the Visual Editor, including replacing built-in blocks, see Integrating Custom Components.

Deploy your updated app to a preview environment

Give others a way to try the Visual Editor integrated with your site.

For more examples of what you can do with Builder, check out the Blueprints, which cover varied use cases at a high-level with code examples.


Looking to hire a third party to help with your project?

Submit a project request and our partnerships team will reach out to connect you with an Expert from our partner ecosystem.

Connect with us

Was this article helpful?

Product

Visual CMS

Theme Studio for Shopify

Sign up

Login

Featured Integrations

React

Angular

Next.js

Gatsby

Get In Touch

Chat With Us

Twitter

Linkedin

Careers

© 2020 Builder.io, Inc.

Security

Privacy Policy

Terms of Service

Get the latest from Builder.io

Newsletter

Developer Newsletter

Latest tips, tricks, and news for frontend developers from our blog

Product Newsletter

Latest features and updates on the Builder.io platform

By submitting, you agree to our Privacy Policy