evktalo/konva

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

#Konva

Konva is an HTML5 Canvas JavaScript framework that enables high performance animations, transitions, node nesting, layering, filtering, caching, event handling for desktop and mobile applications, and much more.

You can draw things onto the stage, add event listeners to them, move them, scale them, and rotate them independently from other shapes to support high performance animations, even if your application uses thousands of shapes. Served hot with a side of awesomeness.

This repository began as a GitHub fork of ericdrowell/KineticJS.

• Visit: The Home Page and follow on Twitter
• Discover: Tutorials, API Documentation
• Help: StackOverflow

#Installation

• bower install konva
• npm install konva - for Browserify. For nodejs you have to install some dependencies
• CDN: https://cdn.rawgit.com/konvajs/konva/0.9.5/konva.min.js

###NodeJS

We are using node-canvas to create canvas element.

1. Install node-canvas https://github.com/LearnBoost/node-canvas/wiki/_pages
2. npm install jsdom@3.x (jsdom v4 require iojs)
3. npm install konva

See file resources/nodejs-demo.js for example.

#Change log

See CHANGELOG.md.

#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 gulp -T to see all build options.

##Building the Konva Framework

To build a development version of the framework, run gulp dev-build. To run a full build, which also produces the minified version run gulp build.

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

##Testing

Konva uses Mocha for testing.

• If you need run test only one time run gulp test.
• While developing it is easy to use gulp default task with with watch. Just run it and go to http://localhost:8080/test/runner.html. After src file change konva-dev.js will be automatically created, so you just need refresh test the page.

Konva is covered with hundreds of tests and well over a thousand assertions. Konva uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.

##Generate documentation

Run gulp api which will build the documentation files and place them in the api folder.

#Pull Requests I'd be happy to review any pull requests that may better the Konva 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 (gulp lint test).