Commencez le développement de plugins KeeeX !

Soyez prêt au développement de plugins KeeeX rapidement.

-

La dernière version de KeeeX embarque une API locale pouvant être utilisée pour développer des plugins, extensions ou connecteurs communiquant avec KeeeX et vous permettant d’afficher et d’interagir avec des données issues de KeeeX et/ou d’autres programmes ou services.

Par exemple, en tant qu’entreprise, vous souhaitez peut-être avoir un connecteur entre votre base de données interne ou votre client email vers KeeeX : tout cela est possible grâce aux plugins KeeeX.

 

NodeJS n’est pas compliqué à apprendre : c’est du langage JavaScript !

Node Webkit vous permet de créer aisément une interface graphique en se basant sur les technologies web : HTML et CSS.

Nous avons déjà implémenté les appels vers l’API locale dans un paquet NPM : facile à ajouter, et démarrage de votre projet simplifié !

Le gestionnaire de plugins peut être lancé depuis l’interface de KeeeX, il gère la publication, l’installation et les mises à jour de plugins.

Le paquet NPM keeex-api contient déjà tous les appels possibles vers l’API locale, vous pouvez donc pleinement vous concentrer sur ce qui importe vraiment pour vous : votre plugin. De plus, créer un plugin KeeeX est très simple, regardez les lignes ci-dessous.

Nos dépôts Git publics peuvent être trouvés ici : https://github.com/KeeeX/

N’hésitez pas à regarder, ou fork n’importe quel plugin qui pourrait correspondre à vos besoins et à l’adapter. Nous avons développé quelques plugins, et ceux-ci sont disponibles sous licence MIT.
Ils peuvent vous donner une idée sur l’interaction possible entre un plugin et l’application KeeeX ou d’autres services.

Comment débuter

Pour commencer le développement de plugins KeeeX, vous aurez besoin des dépendances suivantes :

  • Node JS 4.X
  • nw.js 0.12.3
  • Grunt

Vous pouvez ensuite cloner le plugin Hello World :

git clone https://github.com/KeeeX/helloWorldPlugin.git
cd helloWorldPlugin
npm install
cd src
npm install

Maintenant votre répertoire de travail est prêt. Le code source de votre plugin se trouve dans le répertoire src. Pour vos tests, vous pouvez démarrer le plugin en indiquant le dossier src directement à nwjs.

Lorsque vous souhaitez publier votre travail, lancez grunt build, keeexez le fichier ZIP de sortie dans KeeeX ChatOps et publiez-le à l’aide du Plugin Manager de KeeeX ChatOps.

La documentation de l’API est disponible ici.