lsm/konva
1
0
Fork 0
mirror of https://github.com/konvajs/konva.git synced 2025-04-05 20:48:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

http://localhost:8080/test/runner.html

Browse Source
This commit is contained in:
Лаврёнов Антон 2014-02-27 18:46:15 +08:00
parent ac2cb3c7ea
commit 7c5794f838
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,5 +1,8 @@
Before doing all dev stuff make sure you have node installed. After that, run `npm install` in the main directory to install the node module dependencies.
Run `grunt --help` to see all build options.
#Building the KineticJS Framework
To build the framework, you need to have node installed. After that, run `npm install` in the main directory to install the node module dependencies.
To build a development version of the framework, run `grunt dev`. To run a full build, which also produces the minified version and the individually minified modules for the custom build, run `grunt full`. You can also run `grunt beta` to generate a beta version.
@ -9,9 +12,17 @@ If you add a file in the src directory, be sure to add the filename to the sourc
[![Build Status](https://travis-ci.org/ericdrowell/KineticJS.png)](https://travis-ci.org/ericdrowell/KineticJS)
KineticJS uses Mocha for testing. If you haven't already, be sure to install the npm packages by running `npm install` in the project directory. Before testing you have to build KineticJS by running `grunt dev`.The KineticJS tests must be run on a web server, so you also need to run `node server.js` in the project directory to start the node server. Once the server is running, open http://localhost:8080/test/runner.html to run the tests in your favorite browser. To run the tests in PhantomJS, run `mocha-phantomjs test/runner.html` in the console.
KineticJS uses Mocha for testing.
* If you need run test only one time run `grunt test`.
* While developing it is easy to use `grunt server` with watch task. Just run in in go to http://localhost:8080/test/runner.html. After src file change kinetic-dev.js will be automatically created, so you need just refresh test page.
KineticJS is covered with hundreds of tests and well over a thousand assertions. KineticJS uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.
#Generation documentation
`grunt gen-doc`
#Pull Requests
I'd be happy to review any pull requests that may better the KineticJS project, in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples). Before doing so, please first make sure that all of the tests pass.
I'd be happy to review any pull requests that may better the KineticJS project, in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples). Before doing so, please first make sure that all of the tests pass (`grunt test`).