Web interface for Surveil
Go to file
Frédéric Vachon 86c9cc76d7 JSLint: Unused variables raise errors 2015-02-20 14:38:12 -05:00
app JSLint: Unused variables raise errors 2015-02-20 14:38:12 -05:00
container Docker's apache now listens on port 8080 2015-02-19 11:17:32 -05:00
e2e-tests First commit based on angular-seed 2014-12-16 17:05:07 -05:00
.bowerrc First commit based on angular-seed 2014-12-16 17:05:07 -05:00
.gitignore Add uglify to grunt tasks 2015-02-20 13:39:16 -05: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
Gruntfile.js JSLint: Unused variables raise errors 2015-02-20 14:38:12 -05:00
LICENSE Add LICENSE 2015-02-10 17:02:26 -05:00
Makefile Docker's apache now listens on port 8080 2015-02-19 11:17:32 -05:00
bower.json Add moments.js to project 2015-01-30 14:02:06 -05:00
karma.conf.js Table first draft 2015-01-20 14:29:10 -05:00
package.json Add uglify to grunt tasks 2015-02-20 13:39:16 -05:00
readme.rst Update readme.rst 2015-02-20 14:27:35 -05:00

readme.rst

Adagios FrontEnd

Installation

sudo apt-get install npm nodejs-legacy ruby
git clone https://github.com/titilambert/adagios-frontend.git
cd adagios-frontend
npm install
npm install grunt-cli
gem install sass

Dev

You must leave grunt running in the background to automatically compile css and minify/compress js files when source code changes

grunt

To compile css files run :

grunt sass

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:8080/app

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

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/adagios-frontend
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 adg
  • Make sure your controllers are suffixed with Ctrl
  • Resolve merge conflicts locally