x/bansho
Code Issues Proposed changes
Web interface for Surveil
330 Commits 1 Branch 25 Tags 1.8 MiB
JavaScript 36.1%
CSS 24.9%
SCSS 24.9%
HTML 12%
Shell 1.3%
Other 0.7%
b9de9d7071
Go to file
aviau b9de9d7071 Actionbar: Added notifications 
Change-Id: Ib6889e9097604dd05412dab07b3d12bd97560d96
2015-05-20 09:23:09 -04:00
app Actionbar: Added notifications 2015-05-20 09:23:09 -04:00
container Added BANSHO_AUTH_URL variable 2015-05-06 17:40:56 -04:00
debian Remove useless commands in debian/rules 2015-04-29 23:46:31 -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 Add development config for automatique login 2015-05-15 10:05:21 -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
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
Dockerfile Added BANSHO_AUTH_URL variable 2015-05-06 17:40:56 -04:00
Gruntfile.js Improve login and logout + replaced tabs by spaces 2015-05-15 16:34:49 -04:00
karma.conf.js Fix unit tests issues 2015-02-20 15:14:58 -05:00
LICENSE Add LICENSE 2015-02-10 17:02:26 -05:00
Makefile Fix dependency injection when minimize 2015-05-05 14:45:02 -04:00
package.json Remove useless version number in json 2015-05-05 16:41:14 -04:00
README.rst Added Bansho picture to README 2015-05-15 15:37:49 -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
npm 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

Bansho supports only surveil. To select the proper backend and compile sass for surveil run :

grunt development:surveil

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