Skip to content
This repository was archived by the owner on Sep 8, 2020. It is now read-only.

Commit 29666d4

Browse files
committed
chore(README): add doc testing
1 parent 816c828 commit 29666d4

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ui-sortable directive [![Build Status](https://travis-ci.org/angular-ui/ui-sortable.png)](https://travis-ci.org/angular-ui/ui-sortable)
1+
# UI.Sortable directive [![Build Status](https://travis-ci.org/angular-ui/ui-sortable.png)](https://travis-ci.org/angular-ui/ui-sortable)
22

33
This directive allows you to sort array with drag & drop.
44

@@ -80,3 +80,33 @@ Feel free to edit any of them for your needs (don't forget to also update the li
8080

8181
- [Simple Demo](http://codepen.io/thgreasi/pen/BlFLp)
8282
- [Connected Lists](http://codepen.io/thgreasi/pen/apwsb)
83+
84+
85+
## Testing
86+
87+
We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt:
88+
89+
```sh
90+
npm install -g grunt-cli
91+
npm install && bower install
92+
grunt
93+
```
94+
95+
The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in `test\karma.conf.js`
96+
97+
98+
### Grunt Serve
99+
100+
We have one task to serve them all !
101+
102+
```sh
103+
grunt serve
104+
```
105+
106+
It's equal to run separately:
107+
108+
* `grunt connect:server` : giving you a development server at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
109+
110+
* `grunt karma:server` : giving you a Karma server to run tests (at [http://localhost:9876/](http://localhost:9876/) by default). You can force a test on this server with `grunt karma:unit:run`.
111+
112+
* `grunt watch` : will automatically test your code and build your demo. You can demo generation with `grunt build:gh-pages`.

0 commit comments

Comments
 (0)