diff --git a/README.rst b/README.rst index 6532898..d7ad7c3 100644 --- a/README.rst +++ b/README.rst @@ -4,45 +4,50 @@ Bansho -Installation -============ +Production +========== + :: - sudo apt-get install npm nodejs-legacy ruby + sudo apt-get install docker.io git clone https://github.com/savoirfairelinux/bansho cd bansho + make build + make production + + +You can alternatively forge a Docker command to select your port. + + +Development +=========== + +Clone project : + +:: + + git clone https://github.com/savoirfairelinux/bansho + cd bansho + + +Install development dependencies : + +:: + + sudo apt-get install npm nodejs-legacy ruby-sass docker.io + npm install grunt-cli npm install - gem install sass + make build + make daemon -Dev -=== - -Load our dev virtualenv : +Bansho supports only surveil. +To select the proper backend and compile sass for surveil run : :: - 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 + grunt development:surveil If you wish to develop in a docker container, here is how to proceed (assuming @@ -50,19 +55,16 @@ 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 + + curl http://localhost:8888/ + + +To only compile sass files to css run : :: - grunt - - + grunt sass Coding style diff --git a/app/components/live/adagios.js b/app/components/live/adagios.js index dcd40bf..e98cf11 100644 --- a/app/components/live/adagios.js +++ b/app/components/live/adagios.js @@ -1,3 +1,5 @@ +// Deprecated! +// To support this backend format to the same format as the surveil.js to inject a backendClient. 'use strict'; angular.module('bansho.live', [])