Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.33 KB

README.md

File metadata and controls

35 lines (18 loc) · 1.33 KB

🔌 webdeck-plugin-template

This is a starting repo to create plugins for the webdeck web app. Everything is set up in this template to get started. Press the Use this Template to create a new plugin.

Usage

To try out this plugin, paste the url to this repo into you plugins and you are ready to go! This plugin template is for the webdeck.

Once you setup, an important reference point is the wiki of plugin development. Check it out! It will help you to create your first plugin.

Contributing

If you would like to contribute to this plugin by adding new features or improve existing ones, follow the steps below:

Install dependencies

To get started, install the dependencies

npm install

Once all the dependencies are installed you can start the application.

npm run start

Now navigate to <App> component and make changes.

Deploying you plugin

This repo comes with a Github Action (CI/CD). As soon as you push to master, the application will build and be deployed to github-pages. Once complete you can test the plugin by adding the link to webdeck.


Happy hacking!