Before all you should have node js and npm installed.
The project is build and tested via GruntJS
npm install -g grunt-cli
Clone the project locally:
git clone https://github.com/fdelbos/coolforms.git
Go to the project directory:
cd coolforms
Install node dependencies:
npm install
Once everything is installed you can simply run grunt to build the js file and it's minified version.
grunt
If you want to develop your own features or participate to the project, you most likely want to run the unit tests. To do so run:
grunt test
on the command line, it will start karma. Karma is configured for Chrome by default but you can add your favorite browser by adding it to karma.conf.coffe
in the entry browsers
for example if you want to test in firefox as well, write :
browsers: ['Chrome', 'Firefox']
Also a test server is available with a demo page for convenience, you can start server with grunt server
and go to http://localhost:8000/demo/ to view it. Note that in this mode Grunt will watch the files in src
and rebuild coolform.js
if it detect a change. Finaly grunt test
and grunt server
are not exclusives, you can run them simultaneously.