====== Bansho ====== Installation ============ :: sudo apt-get install npm nodejs-legacy ruby git clone https://github.com/savoirfairelinux/bansho cd bansho npm install gem install sass Dev === Load our dev virtualenv : :: source dev_virtualenv To compile css files run : :: grunt sass Adagios frontend now supports two backends : adagios and surveil. To compile js for adagios run : :: grunt uglify:adagios To compile js for surveil run : :: grunt uglify:surveil If you wish to develop in a docker container, here is how to proceed (assuming you already have docker installed) : :: make build make daemon curl http://localhost:8888/app You must leave grunt running in the background to automatically compile css and minify/compress js files when source code changes By default, grunt uses surveil backend :: grunt Coding style ============ This project conforms to JSLint coding style (http://github.com/douglascrockford/JSLint). Run the linter as follows: :: grunt jslint Tests ===== AngularJS comes with Karma which is an automatic unit test runner. While running, Karma automatically executes the tests when any js file changes. To launch Karma : :: npm test Launch ====== :: npm start Now, go on http://127.0.0.1:8000/app/ Contributing ============ To contribute to this project, please fork the repo. Then do your commits (branch as you will) and then open a pull-request to this repo's master branch. :: git clone your-repo/bansho git checkout -b dev-new-feature-xx git commit ... git push origin dev-new-feature-xx Good practices before opening a pull request: - Run tests with `npm test` - Lint your .js files with `grunt jslint` - Make sure your directives are prefixed with `bansho` - Make sure your controllers are suffixed with `Ctrl` - Resolve merge conflicts locally