Quickstart (opens in a new tab) accelerates getting a developer up and running with apps that use Hellō. It returns a client_id by creating a new app with defaults, or selecting an existing Hellō app.

There are three mechanisms to invoke Quickstart:

  1. Load with query parameters, as documented below. This can be used by any configuration script that can launch a browser
  2. Run the Quickstart CLI as documented here.
  3. Import the @hellocoop/quickstart npm package as documented here.

(2) and (3) both start a local web server on an unused port and launch the default web browser to load the Quickstart Web App.

You can add Hellō Quickstart to a sample application, plug-in, or other software module with the web redirect API below.

Launching Quickstart

You load (opens in a new tab) with the following optional query parameters:

response_uriURI that Quickstart will redirect to with the client_id query parameter if provided
suffixString that will be appended to the suggested name (eg: John's + suffix) for an app to be created. Defaults to "Application"
integrationApplication that started Quickstart, shown in console, defaults to quickstart
nameName of the application (suffix param is ignored if name param is provided)
tos_uriURI to the Terms of Service
pp_uriURI to the Privacy Policy
image_uriURI to the app logo
dark_image_uriURI to the dark theme app logo, which is shown if dark theme is detected in the browser
redirect_uriOne or more space separated OAuth redirect_uri values to be added to the Production Redirect URIs
http:\\localhost:* and http:\\ Development Redirect URIs are enabled by default
wildcard_domaina boolean value indicating if wildcard domains are enabled in Development Redirect URIs
provider_hinta space separated list of recommended providers per provider_hint that will be presented when logging in new users to Quickstart

Quickstart Response

On completion, the Quickstart app will load the response_uri with the client_id query parameter set to the Hellō Client ID, or display the client_id on a completion page if no response_uri was provided.

Try out the Quickstart App (opens in a new tab) to see it in action.