#INF5750 Group Assignment

##Members

• Amund Øgar Meisal
• Christian Bergum Bergersen
• Jarle Fosen
• Vilde Fjeldstad

About

Client web application written in Angular JS.

Code style

Indentation

Javascript

Tab size: 2
Indent: 2
Continuous indent: 2

HTML

Tab size: 2
Indent: 2
Continuous indent: 4

Tools

• NPM - Node Package Modules
• Bower - Package Manager for the Web
• Grunt - JavaScript Task Runner
• Karma
• Jasmine

Setup

It is important that you have NPM intsalled before you run this app. NPM will automatically be installed with Node JS

And then run the following code in root folder.

$ npm install Installs all dependencies defined in package.json

$ bower install is not required since it will automatically be run when $ npm install is done.

$ npm install -g grunt-cli This may require root access (sudo). This is used for running grunt commands in the terminal.

This will install all tools that the project depends on. Including Bower. There exists a script in package.json that installs all bower dependencies when you either start the app or installs npm dependencies.

Remember to run $ npm install when package.json and/or bower.json is updated.

W3C Validation

We have included W3C validation for both CSS and HTML.

You should run it with Grunt.

$ grunt validation will check both CSS and HTML.

$ grunt html-validation checks only HTML

$ grunt css-validation checks only CSS

IF the validation stops showing errors, try deleting validation-report.json and validation-status.json

$ grunt html-angular-validation checks for errors in angular partials.

Linting

The project includes Javascript Linting (eslinting).

$ grunt eslint

If you only want to see linting for the files you were working on, try setting up the commit hook below.

Commit hooks

We can run JavaScript linting after each commit to indicate if you have written anything wrong.

Just run $ ./link_hooks.sh and it will do it's job!

It will check javascript files that you have edited.

Testing

The project runs with Jasmine on Karma-runner for unit-testing.

You can test it continuously with $ grunt test or just once by $ grunt test:fast