Local Dev

Prerequisites

Getting an API Token

The first step for local development is obtaining an API token for the websocket connection. For this, navigate to https://q2developer.com/settings/tokens in a Web browser.

  1. Navigate to “Generate New Token”

  2. Fill in the Note field

  3. Click “Generate Token”

  4. Save that API key somewhere– you’ll need it later.

Choose a path

With that completed, let’s use the caliper admin script to set up your machine for local development.

Warning

If you are transitioning from developing on the shared dev box and already have some extensions installed in the database, these will have to be updated. The easiest way is to run q2 uninstall followed by q2 install on any affected extension. You can also update in place with q2 update_installed, setting the URL to the reported one in the log line Service URL: when running q2 run

Configure your IDE

Once you’re up and running, your next step is configuring your IDE. Check out the guide:

Connect to your Sandbox Database

Once your IDE is setup, an optional step is to connect to your Sandbox Database. Check out the guide: