Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 1.42 KB
Raw

Contributing

Adding new scripts

To add a new third-party script, you can either create a new issue or create a fork of this repository with an addition to src/watcher/DailyTrigger/scripts.json:

  • id: a unique identifier for the script (kebab-case)
  • name: a human readable name for your script
  • url: the initial request URL
  • initialisationHtml: the HTML code required to run the script

...then open a pull request

Running locally

For local development, you'll need to run a number of services (depending on what you're working on)

Dependencies

  • Node JS - v16
  • Docker - only required to run the watcher service

Install project dependencies

npm install

UI

npm start -w ui

UI will be available at http://localhost:1234/

Watcher service

Start a local DB container & seed with test data from container-config/mongo/initdb/init-db.js:

docker-compose up -d

Start the function app:

npm start -w watcher

Manually trigger the function:

curl -v -H "Content-Type:application/json" --data {} http://localhost:7071/admin/functions/DailyTrigger

Shutdown DB container when you're done:

docker-compose down