Skip to content

How to Debug an Open Source BuildFire Plugin

Jump to bottom
o5faruk edited this page May 2, 2021 · 4 revisions

⚠️⚠️⚠️

This sdk documentation is deprecated and will not be updated. Check out our new docs at https://sdk.buildfire.com/docs/how-to-debug-an-open-source-plugin/

⚠️⚠️⚠️

Context

BuildFire is a mobile app building platform that allows developers through HTML, JS and CSS to create plugins for the platform to extend mobile app functionality. learn more at https://buildfire.com

Prerequisites

  • NodeJS - download
  • npm
  • git
  • knowledge on how to create a pull-request on github

Install

  • BuildFire SDK npm i buildfire you may need to be admin or super user depending on your environment
  • Init SDK buildfire init this will install the SDK in a folder called BuildFireSDK
  • Navigate to folder cd BuildFireSDK
  • Clone plugin buildfire plugin clone <plugin name>

example:

buildfire plugin clone folderPlugin from the repo https://github.com/BuildFire/folderPlugin

Run plugin locally

  • Run tester buildfire run this will run a web server on http://localhost:3030
  • in the Plugin input box enter in the name of your plugin. example: 'folderPlugin' depending on your OS this could be case sensitive

Understanding the autonomy of a BuildFire Plugin

  • the Control: is the right hand side of the plugin meant to live in the BuildFire control panel/dashboard
  • the Widget: is the left hand side of the plugin meant to live in the mobile app to learn more click here

Submit a pull request

Additional Information

portal . twitter . facebook

Clone this wiki locally