Set up your Workspace

Log in to Embeddable

Depending on which region your deployment is in, login to the appropriate workspace:

• US: https://app.us.embeddable.com (opens in a new tab)
• EU: https://app.eu.embeddable.com (opens in a new tab)

Retrieve Your API Key

On your workspace homepage, look for your API Key. You’ll need this shortly to push code from your local machine to your workspace.

Push the Code Bundle

Open a terminal in the directory of your Boilerplate Repo and run the following to login to your workspace (make sure the region was set correctly in the previous step):

npm run embeddable:login

Then run the following to push the code bundle (from the previous step) to your workspace:

npm run embeddable:push

If you later want to do this via CI/CD, you can use the following:

npm run embeddable:push -- --api-key <API Key> --email <Email> --message "<Message>"

For example:

npm run embeddable:push -- --api-key c26624b --email my@email.com --message "My first components and models"

Note: if you're using Powershell, you may need to put the -- in double quotes, like so:

npm run embeddable:push "--" --api-key c26624b --email my@email.com --message "My first components and models"

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

Refresh Your Workspace

After the push succeeds:

• Go back to your workspace page.
• Refresh the page.
• You should see a Create new Embeddable button, which means your workspace is now set up.