Installation¶
Note
The following dependencies should be installed on your system in order to work with this Boilerplate.
- Sass: http://sass-lang.com/
- Bootstrap: https://github.com/twbs/bootstrap-sass
- Node JS: http://nodejs.org/
- Gulp: http://gulpjs.com/
You can find most installation steps within osx-bootstrap but in short:
- run
brew install node
when using Homebrew - run
curl -L https://npmjs.org/install.sh | sh
- run
npm install -g bower
- run
npm install -g gulp
At last make sure you correctly configured your paths.
Setup¶
Run the following commands to install all requirements from within the root of the package:
npm install
to install the requirements frompackage.json
bower install
to install the requirements frombower.json
via.bowerrc
Gulp Commands¶
Warning
Please mind that gulp browser
starts browserSync which tries to
connect to a server. A Django server can be started from within
tools/server
. Refer the General section for
additional information.
All front-end related tasks are handled via the Gulp task runner:
gulp
runs the gulp defaultsgulp browser
connects to a given server (django) and runs live reload on a separate IPgulp lint
starts all linting services using.eslintrc.json
andscss-lint.json
gulp preprocess
optimises images within/static/img
and compiles YUIDoc intostatic/docs
gulp sass
to compile the stylesheetsgulp tests
runs the test suitegulp watch
runs the gulp watch defaults
We also offer some standalone commands:
gulp bower
to install the bower dependenciesgulp images
optimises images within/static/img
gulp icons
to create a custom icon webfontgulp docs
compiles YUIDoc intostatic/docs
gulp lint:javascript
runs JavaScript lintinggulp lint:sass
runs Sass lintinggulp tests:unit
runs unit testsgulp tests:integration
runs integration testsgulp tests:watch
runs tests in debugging mode
We love code over configuration.