Contribute - LuccaSA/lucca-ui GitHub Wiki

Checkout and build

Requirements

for this you'll need git, nodejs, grunt and bower.

you can install grunt once you have nodejs by opening a terminal and launching

npm install grunt grunt-cli -g
npm install bower -g

Fetching dependencies

Once you have installed git, node, grunt and bower, clone the repo somewhere. Then open a terminal in the directory and run

npm install
bower install

Using grunt for continuous transpilation

If you either want to work js side of lucca-ui or the less framework, you can run this command

grunt

It will detect each change on a .less file under /src and launch transpilation, it will also detect each change to a .js file under /js and launch the existing karma test as well as concatenation of every js file under /dist/lucca-ui.js and it's uglification under /dist/lucca-ui.min.js

Karma tests

The karma tests are testing the file /dist/lucca-ui.js with the tests defined in the files under /tests/spec/**/*.spec.js. As a result it is recommended to run

grunt

and just work on your js code. If it is under /js/directives/ or /js/filters/ it will be automatically concatenated into /dist/lucca-ui.js` and will be tested by karma.

Protractor tests

The protractor tests will try to access the page http://lucca-ui/tests/e2e.html so you have to have a working local website under http://lucca-ui whose directory is the lucca-ui directory

the page e2e.html already loads lucca-ui.js dependencies, so you can just add your section in it and do your tests with that.

Once it's done just run

grunt protractor:dev