| 1 | KD [](https://travis-ci.org/koding/kd) [](https://david-dm.org/koding/kd#info=devDependencies) [](https://david-dm.org/koding/kd#info=dependencies)
|
| 2 | --
|
| 3 | _a non-document focused UI Framework for web applications._
|
| 4 |
|
| 5 | Install gulp:
|
| 6 |
|
| 7 | ```bash
|
| 8 | $ npm install gulp -g
|
| 9 | ```
|
| 10 |
|
| 11 |
|
| 12 | Build steps:
|
| 13 |
|
| 14 | ```bash
|
| 15 | $ npm i
|
| 16 | $ gulp
|
| 17 | ```
|
| 18 |
|
| 19 | Before building make sure you have these installed:
|
| 20 |
|
| 21 | - [node](http://nodejs.org)
|
| 22 | - [gulp](http://gulpjs.com/)
|
| 23 |
|
| 24 | #### Build the documentation website or create a playground
|
| 25 |
|
| 26 | Documentation website is under `/docs` folder, it is a great example to check how a site can be put together with KD.
|
| 27 |
|
| 28 | You can build & run it by doing:
|
| 29 |
|
| 30 | ```bash
|
| 31 | $ gulp --docs
|
| 32 | ```
|
| 33 |
|
| 34 | or you can create playground to fiddle with the components with this:
|
| 35 |
|
| 36 | ```bash
|
| 37 | $ gulp --play
|
| 38 | ```
|
| 39 |
|
| 40 |
|
| 41 | #### Test Runner
|
| 42 |
|
| 43 | KD uses [karma](http://karma-runner.github.io) for automatically running
|
| 44 | tests. To launch karma, run
|
| 45 |
|
| 46 | ```bash
|
| 47 | $ gulp karma
|
| 48 | ```
|
| 49 |
|
| 50 | If you're editing test files, you'll also need to run the test watcher
|
| 51 | to automatically build the test files:
|
| 52 |
|
| 53 | ```bash
|
| 54 | $ gulp watch-test
|
| 55 | ```
|
| 56 |
|
| 57 | There is also an html based test runner, which can be useful for
|
| 58 | debugging tests. If you're running the playground server (started by
|
| 59 | running `gulp`) the tests are available by going to
|
| 60 |
|
| 61 | [http://localhost:8080/test/index.html](http://localhost:8080/test/index.html)
|
| 62 |
|
| 63 | Alternately, you can view the tests directly in the browser:
|
| 64 |
|
| 65 | ```bash
|
| 66 | $ open test/index.html
|
| 67 | ```
|
| 68 |
|
| 69 | #### Running tests on Saucelabs
|
| 70 |
|
| 71 | You can also run tests remotely on [SauceLabs](https://saucelabs.com)
|
| 72 | browsers.
|
| 73 |
|
| 74 | First, expose your saucelabs username and access key as environment
|
| 75 | variables
|
| 76 |
|
| 77 | ```bash
|
| 78 | $ export SAUCE_USERNAME=your-username SAUCE_ACCESS_KEY=your-access-key
|
| 79 | ```
|
| 80 |
|
| 81 | Then fire up the SauceLabs test runner with
|
| 82 |
|
| 83 | ```bash
|
| 84 | $ gulp sauce
|
| 85 | ```
|
| 86 |
|
| 87 | The available browser definitions are configured in the
|
| 88 | `customLaunchers` key in `karma.conf.js` and then
|
| 89 | selected in the 'sauce' task in `gulpfile.coffe`.
|
| 90 |
|
| 91 |
|
| 92 | ------------------------
|
| 93 |
|
| 94 | #### Disclaimer
|
| 95 |
|
| 96 | __The framework is not well documented yet and the unit tests are in very early stage, any pull requests in this direction is highly appreciated.__
|