The Tidepool export service.
The easiest way to run the Tidepool export service is as part of the Tidepool Development environment.
You'll have to uncomment the export service in the docker-compose.yml
, but after that, you can just run docker-compose up -d
, and you're all set.
If you want to develop any part of the export service, you can run the service locally on Node.
- Install Node version 20.8.0 or later. NVM is highly recommended.
- Execute
nvm use
to use the correct version of Node. - Install Yarn.
- Execute
yarn
to install all dependencies
yarn start:dev
will start the service in development mode. It will watch for changes and restart the service as needed.
yarn test
will run the tests.
yarn lint
will run the linter.
yarn build
will build the service.
Configuration is done via environment variables. The following variables are available:
Variable | Description | Example |
---|---|---|
API_HOST | The hostname of the Tidepool API | https://qa1.development.tidepool.org |
DEBUG_LEVEL | The log level | info |
DEBUG_PDF | Whether to write out files for debugging purposes | false |
PLOTLY_ORCA | The URL of the Plotly Orca service | http://localhost:9091 |
EXPORT_TIMEOUT | The maximum time to wait for a request to complete | 120000 |