ardoq-local-plugins
A utility for developing plugins locally by syncing your updates with the Ardoq API.
Dependencies
Setup (from your working directory)
-
Installation:
npm install ardoq-local-plugins
-
Create a local version of the plugin, i.e. "plugin.js"
-
Create a config file "config.json":
"api": "https://app.ardoq.com/api/" "apiToken": "YOUR-API-TOKEN" // Your API token (created in your Ardoq account settings) "org": "YOUR-ORG-KEY" // Found with your API token "pluginPath": "plugin.js" // Path to your local version of the plugin "pluginData": "plugin.json" // Holds your local version of the plugin, will be created automatically
Usage (from your working directory)
# Run: ./node_modules/.bin/ardoq-local-plugins ? -- Choose a plugin
Now you have successfully synced the plugin to the remote and you can start developing locally!
When you're developing locally, run:
./node_modules/.bin/ardoq-local-plugins
to continually update the remote version of the plugin upon local changes.