andresmoschini / board-poc

board-poc

Try it on http://board-poc.herokuapp.com/ (the board is clean on new connections intentionally)

Development environment setup

Steps to follow:

1. Clone or download the project from the Github repository.
2. Install Node.js. For example node-v4.2.4-x86.msi.
3. Install Global Node Packages
   • Gulp npm install -g gulp
   • TypeScript npm install -g typescript.
   • TypeScript Definition manager npm install -g tsd.
   • Bower npm install -g bower.
   • Browserify npm install -g browserify.
   • TypeStrong tsify npm install -g tsify.
4. Run npm install. With that will be installed all node dependencies, front-end dependencies using bower and will be compiled all typescript files.
5. Finally should be run npm start.

Add new dependencies

New dependencies could be added using Bower, in that case, the reference should be added to HTML files.

Also, npm dependencies could be added and consumed using import ... = require(...).

With both, npm and bower, we need TypeScrip definitions. If DefinitelyTyped definitions are available it is enough to call tsd install ... --save and add the reference to the right files.

If DefinitelyTyped definitions are not available, it is possible to create our own definitions, see the folder custom-typings.

How to test

The tests should be run using gulp test.

When a change is made to the files that are defined running, it's possible to run tests each time using gulp watch-test.

Add new tests

New tests should be defined using Jasmine and typescript. This files should be saved on src/test