Routine Developer Guide

Environment requirement

• NodeJS 20
• Chrome browser

Develop a Routine

Clone Routine repository

git clone https://github.com/puppilot-org/puppilot-routines.git
# or if you prefer ssh
# git clone git@github.com:puppilot-org/puppilot-routines.git

cd puppilot-routines

Setup environment

# install dependencies
npm clean-install

# create new .env file
cp .env.example .env

Create new Routine

# copy from template
cp src/routines/__template.ts src/routines/my-routine.ts

and edit .env file to change DEBUG_SCRIPT to the new file name

Edit Routine file

Edit your routine file. see Routine Api for reference

Puppeteer will be used as browser interactions. Please refer to Puppeteer document

Debug Routine

npm start

Publish Routine

Fork this repository, push your commits and create a pull request on github