Whether you’re a WVUS developer or a vendor, we can always make improvements. The UiKit was created to be platform independent and easily extended.
Before you start…
In order to build the World Vision UiKit, there are a couple of prerequisites that need to be installed:
- Install the Node.js Package Manager (npm)
- Install Grunt using
npm install -g grunt-cli
- Run
npm install
in/path/to/wvus.uikit
to install all development dependencies
You’re ready to start building out the uikit!
Code Standards
The UiKit has adopted the standards of Twitter Bootstrap. The major exception is to use semicolons in JavaScript.
There is also a .editorconfig
file (adopted from Bootstrap) to set the guidelines in popular text editors.
Compiling CSS and JavaScript
The UiKit uses Grunt to build out and quickly run tasks to compile code. If you haven’t used Grunt before, start here to get an overview or jump right in with running some of the tasks listed below.
Available Grunt Commands
grunt dist-css
: Compiles LESS into CSS. This includes minified and source maps
grunt dist-js
: Concatenates and minifies JS
grunt dist
: Combines dist-css
and dist-js
. Creates a zip for distribution.
Dependencies
The UiKit depends on several libraries which provide the base functionality. Thanks go out to the developers behind Twitter Bootstrap, Font Awesome and jQuery. Some ideas were also inspired by Zurb Foundation.