Start developing KeeeX plugins !
Get started in KeeeX plugin development quickly.
The latest KeeeX version embeds a local API which can be used to develop plugins, extensions or connectors communicating with KeeeX and allowing you to display and interact with KeeeX data and/or other programs or services.
As a company, you may want to have a connector to your internal database or your email client : all these are possible via KeeeX plugins.
Node Webkit allows you to create UI easily with web technologies such as HTML and CSS
We already implemented local API calls in a NPM package : easy to implement, and kickstart your plugin project !
Plugin Manager can be launched from the KeeeX interface, managing plugins publication, installation and updates.
The NPM package keeex-api already contains all possible calls to the local API, so you can directly focus on what really matters to you : your plugin. And creating a KeeeX plugin is as simple as the lines below.
To start developping KeeeX plugins, you will need the following requirements :
- Node JS 4.X
- nw.js 0.12.3
Then, you can clone the Hello World Plugin :
git clone https://github.com/KeeeX/helloWorldPlugin.git cd helloWorldPlugin npm install cd src npm install
Now you workspace should be ready. The source code of the plugin sits in the src folder. For your tests, you can start the plugin by giving the
src folder directly to nwjs. When you’re happy with your work, you can then
grunt build, keeex the zip file within KeeeX ChatOps and publish it on the Plugin Manager.