Web interface for Surveil
Go to file
Thibault Cohen f15a6ccf93 Fix dist generation
Change-Id: I3bfea037e13bff226db21baeccf5da9090df4210
2015-06-19 16:15:52 -04:00
app Add surveil-webui logo and remove Bansho 2015-06-19 15:11:43 -04:00
container Silence dashboard configuration 2015-06-19 12:03:39 -04:00
debian Update packaging 2015-05-26 16:14:52 -04:00
e2e-tests First commit based on angular-seed 2014-12-16 17:05:07 -05:00
.bowerrc Container: From npm to apache 2015-04-20 17:20:36 -04:00
.dockerignore Made container configurable 2015-04-23 10:51:43 -04:00
.gitignore Remove adagios backend 2015-05-20 13:25:16 -04:00
.gitreview Add .gitreview 2015-05-21 11:03:45 -04:00
.jshintrc First commit based on angular-seed 2014-12-16 17:05:07 -05:00
.travis.yml First commit based on angular-seed 2014-12-16 17:05:07 -05:00
Dockerfile Added arguments to configure-dashboard.sh 2015-06-17 11:13:38 -04:00
Gruntfile.js Fix dist generation 2015-06-19 16:15:52 -04:00
LICENSE Add LICENSE 2015-02-10 17:02:26 -05:00
Makefile Drupal makefile entry 2015-06-05 11:46:31 -04:00
README.rst Remove adagios backend 2015-05-20 13:25:16 -04:00
bower.json Actionbar: Added notifications 2015-05-20 09:23:09 -04:00
dev_virtualenv Fix dev_virtualenv 2015-03-21 20:30:32 -04:00
karma.conf.js Fix unit tests issues 2015-02-20 15:14:58 -05:00
package.json Fix pnotify css import 2015-06-18 15:59:51 -04:00

README.rst

Bansho

Web Interface for Surveil

Bansho interface picture

Production

sudo apt-get install docker.io
git clone https://github.com/stackforge/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/stackforge/bansho
cd bansho

Install development dependencies :

sudo apt-get install npm nodejs-legacy ruby docker.io
npm install grunt-cli bower
npm install
bower install
gem install sass
make build

Start the Docker container (be sure to have a surveil container available at this link: https://github.com/stackforge/surveil )

make daemon

If you wish to develop in a docker container, here is how to proceed (assuming you already have docker installed) :

curl http://localhost:8888/

To only compile sass files to css run :

grunt sass

Coding style

This project conforms to JSLint coding style (http://github.com/douglascrockford/JSLint). Run the linter as follows:

grunt jshint

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.

<fork this repo on github>
git clone your-repo/bansho
git checkout -b dev-new-feature-xx
git commit ...
git push origin dev-new-feature-xx
<You can now open your pull-request to this repo's master>

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