Getting started
1: Set up your repo

Set up your Repo

Takes ~3 mins
💡

Embeddable requires Node.js version 20 or later.

Download our Boilerplate Repo

Download or clone our boilerplate repo here (opens in a new tab).

git clone https://github.com/embeddable-hq/remarkable-pro-boilerplate

This includes:

  • the full suite of Remarkable Pro components, our production-ready component library.
  • a set of sample data models for you to play with.

Install Dependencies

Navigate into the cloned directory and install the required dependencies:

cd remarkable-pro-boilerplate
 
npm i

If you don't have npm, this means you need to install Node.js first (here (opens in a new tab))

Set Your Region

In your embeddable.config.ts (opens in a new tab) file, depending on your region, uncomment either:

region: 'US',

or

region: 'EU',

If you’re unsure which region you’re using, please reach out to us.

Build the Code Bundle

Run the following command to build your code bundle:

npm run embeddable:build

This bundles up your components and models, ready to be pushed to your Embeddable workspace.

Next steps

You're now ready to set up your workspace and push your first code bundle.