diff options
Diffstat (limited to 'js/README.md')
-rw-r--r-- | js/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/js/README.md b/js/README.md new file mode 100644 index 000000000..fb497f368 --- /dev/null +++ b/js/README.md @@ -0,0 +1,38 @@ +# News + +You'll need node.js version > 0.8 + +## Compile coffeescript +To compile the coffeescript run: + + make + +If you want to autocompile on change run: + + make watch + +## Running unittests +Unittests are run with the testacular: + + make testacular + +afterwards the watch command can be run in a new terminal: + + make watch + +This will automatically execute unittests when a coffeescript file has been changed and saved. + +### PHPUnit +To run phpunittests once a file changed, simply run + + make phpunit + +## Clear compiled folder +To clear the build/ folder run: + + make clean + +## Run js unittests +To run js unittests with the ci server, use + + make test
\ No newline at end of file |