Web interface for Surveil
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 0f4bdef7c5 OpenDev Migration Patch 4 days ago
app Clean config.js and remove container 3 years ago
container Added 'N' option is getopt 3 years ago
debian Update packaging 3 years ago
e2e-tests First commit based on angular-seed 4 years ago
.bowerrc Container: From npm to apache 4 years ago
.dockerignore Made container configurable 4 years ago
.gitignore Remove adagios backend 3 years ago
.gitreview OpenDev Migration Patch 4 days ago
.jshintrc First commit based on angular-seed 4 years ago
.travis.yml First commit based on angular-seed 4 years ago
Dockerfile Surveil - New default port: 5311 3 years ago
Gruntfile.js Font awesome available in production 3 years ago
LICENSE Add LICENSE 4 years ago
Makefile Ignore errors on 'make remove' 3 years ago
README.rst Remove adagios backend 3 years ago
bower.json Begin to integrate angular-material (on table component) 3 years ago
dev_virtualenv Fix dev_virtualenv 4 years ago
karma.conf.js Fix unit tests issues 4 years ago
package.json Fix pnotify css import 3 years ago

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