Skip to main content

Getting Started


  • A Thought Industries Enterprise Learning Cloud account and API key
  • Node 14 or higher. This can be checked by running node -v.
  • NPM 8.6.0 or higher
Helpful Tip

There is also a video tutorial of the Getting Started guide that can be found here.

Step 1: Create a Helium App

Run the following command in your terminal

 npm init helium-app@latest

This will prompt you to install the @thoughtindustries/helium package if you do not already have it installed on your local machine.

Step 2: Choose a Theme

Selete a theme to get started building your Helium app.

$  ? Which theme would you like to use (Use arrow keys)
$ > Starter App
$ Hello World

Step 3: Install Packages

cd in to the name of your Helium app and install the packages

npm install

Step 4: Connect to a Learning Instance

Next, you'll connect your learning instance to your Helium app with npm run authenticate

 npm run authenticate

After you run npm run authenticate, enter the following data:

  • The URL of your learning instance
  • The API key (located under Settings > Security > API Key)
  • A nickname for this instance (sandbox, production, test-one)
  • Determine if you want to add another instance

This command should generate a ti-config.json file in your root directory. For example, if you named your helium app test-one there shoul be a file under test-one/ti-config.json. If this file did not generate, re-run the above authenticate command.

Step 5: Start Your Development Server

This command will start a local develelopment server.

npm run dev

Step 6: Deploy Your Helium App

This command will deploy your Helium app to Cloudflare workers managed by Thought Industries. The Helium feature flag must be turned on for you to deploy succesfully.

npm run deploy [nickname]
Best Practice

You can add multiple instances to your ti-config.json file. We strongly recommend deploying and testing code in your sandbox enviorment before deploying to your production enviorment.