Set up your workspace

The boilerplate repository (opens in a new tab) is the starting point for this guide. It includes:

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

Clone our boilerplate repo to your machine using the git command:

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

Navigate into the cloned directory using your Terminal and install the required dependencies:

cd remarkable-pro-boilerplate

npm i

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

Open the embeddable.config.ts (opens in a new tab) file in your code editor. Depending on your region, set either:

region: 'US',

region: 'EU',

If you're unsure which region you're using, learn more here or reach out to us.

Run the following command to login to your workspace:

npm run embeddable:login

Next, bundle the boilerplate repository, by running:

npm run embeddable:build

Then run the following to push the code bundle to your workspace:

npm run embeddable:push

This uploads your data models (opens in a new tab) and components (opens in a new tab) to your team workspace so you can use them in the Embeddable platform to build a dashboard.

To learn more about the push command and its options, see Push Command.

Next steps