konva

lsm/konva

mirror of https://github.com/konvajs/konva.git synced 2025-04-05 20:48:28 +08:00

Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.

animation canvas drag-and-drop graphics javascript konva node-canvas shape

Go to file

Liwen 6912c777e3 bower package name fixed		2014-05-06 22:37:19 +08:00
doc-includes	add dragDistance to node config docs	2014-03-12 00:06:31 +08:00
src	improve shouldDrawHit behaviour	2014-05-06 16:21:25 +08:00
test	improve shouldDrawHit behaviour	2014-05-06 16:21:25 +08:00
.gitignore	ignore docs folder	2014-04-01 09:41:32 +08:00
.jshintrc	only lint errors fixes	2014-02-27 08:49:18 +08:00
.npmignore	typo fix	2014-04-18 09:12:10 +08:00
.travis.yml	npm ready	2014-04-17 17:58:51 +08:00
bower-template.json	update ignore files, update package files	2014-04-14 15:17:57 +08:00
bower.json	update ignore files, update package files	2014-04-14 15:17:57 +08:00
Gruntfile.js	npm ready	2014-04-17 17:58:51 +08:00
kinetic.js	improve image drawing performance	2014-05-05 11:09:31 +08:00
kinetic.min.js	improve image drawing performance	2014-05-05 11:09:31 +08:00
nodejs-demo.js	update NodeJS example	2014-03-04 19:43:06 +08:00
package.json	npm ready	2014-04-17 17:58:51 +08:00
presentation-schedule.md	Update presentation-schedule.md	2013-08-22 08:18:38 -04:00
README.md	bower package name fixed	2014-05-06 22:37:19 +08:00

README.md

#Hiatus

Hi all! I will be taking a 3 month break from KineticJS (until July 2014) to focus on other endeavors. KineticJS is in a great state right now (v5.1.0). Please continue to file any issues that you may find, or submit pull requests. They will eventually be addressed.

#Installation

bower install kineticjs
npm install kinetic - for Browserify. For nodejs you have to install some dependencies

###NodeJS

Support of NodeJS is experimental.

We are using node-canvas to create canvas element.

Install node-canvas https://github.com/LearnBoost/node-canvas/wiki/_pages
npm install jsdom
npm install kinetic

See file nodejs-demo.js for example.

#Dev environment

Before doing all dev stuff make sure you have node installed. After that, run npm install --dev in the main directory to install the node module dependencies.

Run grunt --help to see all build options.

##Building the KineticJS Framework

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.

If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in Gruntfile.js.

##Testing

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 it and go to http://localhost:8080/test/runner.html. After src file change kinetic-dev.js will be automatically created, so you just need refresh test the 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

Run grunt docs which will build the documentation files and place them in the docs folder.

#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 (grunt test).