Skip to content

Latest commit

 

History

History
76 lines (43 loc) · 1.62 KB

HACKING.md

File metadata and controls

76 lines (43 loc) · 1.62 KB

Build Requirements

You will need to have nodeJS installed on your system. You can install it via the installers provided on the site or follow the installation guide here

Building

Building is done with jake, JavaScript minifying is done with Uglify-js and CSS minifying is done with CleanCSS.

If you don't already have Jake installed, first install it using npm with:

npm install -g jake

Next, ensure you're in the root directory of the project then install development dependencies with:

npm install

Finally, build bbUI.js:

jake

or

jake build

Hacking

Finding your way around:

src/

core.js

Contains code for managing screens and managing the styling.

bbUI.css

Contains all of the css rules for bbUI.

plugins/

Contains all of the UI plugins. Each plugin should be in the format of:

pluginName.js:

bb.pluginName = {
    apply: function (elements) {
        //code to apply styling to the elements
    }
};

screenshots/

Example screenshots for use in README.md

samples/

An example app that showcases each of the bbUI.js plugins.

pkg/

The build location and also contains the current

TODO:

  • Fix the core.js registeration of plugins. Currently they are all hardcoded in the doLoad function
  • Plugins should define their own css and have it built into bbUI.css
  • More linting should be done
  • add linting step into build