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:
https://quickstart.hello.coopwith query parameters, as documented below. This can be used by any configuration script that can launch a browser
- Run the Quickstart CLI as documented here.
- Import the
@hellocoop/quickstartnpm 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.
You load https://quickstart.hello.coop/ (opens in a new tab) with the following optional query parameters:
|URI that Quickstart will redirect to with the |
|String that will be appended to the suggested name (eg: John's + suffix) for an app to be created. Defaults to "Application"|
|Application that started Quickstart, shown in console, defaults to |
|Name of the application (|
|URI to the Terms of Service|
|URI to the app logo|
|URI to the dark theme app logo, which is shown if dark theme is detected in the browser|
|One or more space separated OAuth |
|a boolean value indicating if wildcard domains are enabled in Development Redirect URIs|
|a space separated list of recommended providers per provider_hint that will be presented when logging in new users to Quickstart|
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.