logoAcademy

Setup AvaCloudSDK Starter Kit

Set up the AvaCloudSDK Starter Kit in a GitHub Codespace

In this course we will run the AvaCloudSDK Starter Kit in a Github Codepsace. This is the quickest way to get started.

The AvaCloudSDK Starter Kit contains everything we need to get started quickly with the AvaCloud API.

Create a Codespace

  • Click the green Code button
  • Switch to the Codespaces tab
  • Click Create Codespace on main or if you already have a Codespace click the plus (+) button

The Codespace will open in a new tab. Wait a few minutes until it's fully built.

Verify everything is working correctly

Open the terminal with Ctrl + ` or by opening it through the menu:

Set the AVACLOUD_API_KEY environment variable

Create a .env file in the root of the project and add your API key from the previous step:

AVACLOUD_API_KEY=ac_rGIKESl9_9DWuLfJJQLSV5nlzbKR7eHxym6XW3XEQJeNBDRxI...

Start the NextJS app

Now we can run the NextJS app in hot reload mode:

yarn dev

It should preview within the Codespace:

Optional: Open Codespace locally in Visual Studio Code

You can switch any time from the browser IDE to Visual Studio Code:

The first time you switch, you will be asked to install the Codespaces extension and connect VS Code to you GitHub account, if it is not already connceted.

On this page