Getting started
2: Set up your workspace

Set up your Workspace

Let’s get your workspace configured in just a few steps.

Log in to Embeddable

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

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 Starter Repo and run:

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

e.g:

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

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

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

This uploads your data models and components so you can use them in the Embeddable platform.

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.

Next Steps