Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 1.01 KB

README.md

File metadata and controls

29 lines (24 loc) · 1.01 KB

airfocus-automation

Kickstart your own airfocus automation handler with ease!

Getting started

  • Log into your airfocus account and create an API key in your account settings (API keys are only available in higher tier plans).
  • Clone this repository.
  • Run the following preparational steps:
    npm ci
    npm run init -- --name my-airfocus-automation
    cp .env.example .env
    # add correct values to .env file
  • Implement your custom automation logic. You can find some examples here.
  • Test locally by running (using ngrok to make your local instance available from the public internet):
    npm start
  • Publish as container image by running:
    npm run build-docker
  • Deploy and run on your server. Make sure that you make it reachable via HTTPS with a valid certificate, for example by using a reverse proxy and Let's encrypt.

Disclaimer

This repository is only intended as template and comes with no support.