@sobol/app

A starter app designed for integrations with Sobol.

Installation

To download and setup this package, run:

mkdir my-app
cd my-app
curl -SL $(npm view @sobol/app dist.tarball) | tar --strip-components 1 -xvz
npm install

Prerequisites

Before running the app, you must first aquire a Sobol API key:

1. In Sobol, navigate to Settings -> Applications
2. Create a new application
3. Assign desired permissions (Webhooks require all the application permissions)
4. In the app, create a .env file at the project root
5. Add your key as SOBOL_API_KEY=XXXXX
6. Add some random example key as EXAMPLE_API_KEY=...

Development

To run the app locally, you need to install ngrok and then:

1. Run ngrok http 8085
2. Copy the https ngrok url to the .env file as follows SOBOL_WEBHOOK_URL=<NGROK_URL>/development/events/sobol
3. Next set SOBOL_API_URI if not working against production (eg. SOBOL_API_URI=http://localhost:8080/api/v1)
4. Then run yarn start or yarn debug to bring up inspector

Production

To run in production:

1. In .env, set NODE_ENV=production and set SOBOL_WEBHOOK_HOST to your server's hostname
2. Run yarn start-production

Help and Feedback

For help and feedback, please send us an email to [email protected] and we will respond as soon as possible.