konva/README.md

#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.

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/konvajs/konva?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![npm version](https://badge.fury.io/js/konva.svg)](http://badge.fury.io/js/konva) [![bower version](https://badge.fury.io/bo/konva.svg)](http://badge.fury.io/bo/konva)
[![Build Status](https://travis-ci.org/konvajs/konva.png)](https://travis-ci.org/konvajs/konva)  [![Code Climate](https://codeclimate.com/github/konvajs/konva/badges/gpa.svg)](https://codeclimate.com/github/konvajs/konva)

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](https://github.com/ericdrowell/KineticJS).

* **Visit:** The [Home Page](http://konvajs.github.io/) and follow on [Twitter](https://twitter.com/lavrton)
* **Discover:** [Tutorials](http://konvajs.github.io/docs), [API Documentation](http://konvajs.github.io/docs)
* **Help:** [StackOverflow](http://stackoverflow.com/questions/tagged/konvajs)

#Installation

* `bower install konva`
* `npm install konva` - for Browserify. For nodejs you have to install some [dependencies](#nodejs)
* CDN: [https://cdn.rawgit.com/konvajs/konva/0.9.5/konva.min.js](https://cdn.rawgit.com/konvajs/konva/0.9.5/konva.min.js)

###NodeJS

We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.

1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](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](https://github.com/konvajs/konva/blob/master/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 watch. Just run it and go to [http://localhost:8080/test/runner.html](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`).
fix 2015-01-27 13:35:39 +08:00			`#Konva`
update readme 2015-01-09 20:51:36 +08:00
update name 2015-01-27 13:34:30 +08:00			`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.`
readme updates 2015-01-23 14:05:11 +08:00
update name 2015-01-27 13:34:30 +08:00			`[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/konvajs/konva?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)`
Added Gitter badge 2015-01-15 11:51:18 +08:00
Renaming 2015-01-27 15:07:51 +08:00			`[![npm version](https://badge.fury.io/js/konva.svg)](http://badge.fury.io/js/konva) [![bower version](https://badge.fury.io/bo/konva.svg)](http://badge.fury.io/bo/konva)`
Fix README 2015-01-27 15:12:36 +08:00			`[![Build Status](https://travis-ci.org/konvajs/konva.png)](https://travis-ci.org/konvajs/konva) [![Code Climate](https://codeclimate.com/github/konvajs/konva/badges/gpa.svg)](https://codeclimate.com/github/konvajs/konva)`
fix typo 2015-01-09 21:08:35 +08:00
update readme 2015-01-09 20:51:36 +08:00			`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.`

Fix README 2015-01-27 15:12:36 +08:00			`This repository began as a GitHub fork of [ericdrowell/KineticJS](https://github.com/ericdrowell/KineticJS).`
readme updates 2015-01-23 14:05:11 +08:00
update name 2015-01-27 13:34:30 +08:00			`* Visit: The [Home Page](http://konvajs.github.io/) and follow on [Twitter](https://twitter.com/lavrton)`
			`* Discover: [Tutorials](http://konvajs.github.io/docs), [API Documentation](http://konvajs.github.io/docs)`
			`* Help: [StackOverflow](http://stackoverflow.com/questions/tagged/konvajs)`
update readme 2015-01-09 20:51:36 +08:00
update installation notes 2014-05-05 19:00:31 +08:00			`#Installation`

update name 2015-01-27 13:34:30 +08:00			* `bower install konva`
			* `npm install konva` - for Browserify. For nodejs you have to install some [dependencies](#nodejs)
update cdn link 2015-05-28 14:29:12 +08:00			`* CDN: [https://cdn.rawgit.com/konvajs/konva/0.9.5/konva.min.js](https://cdn.rawgit.com/konvajs/konva/0.9.5/konva.min.js)`
update installation notes 2014-05-05 19:00:31 +08:00
			`###NodeJS`

			`We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.`

			`1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)`
update node instructions 2015-08-28 11:41:10 +08:00			2. `npm install jsdom@3.x` (jsdom v4 require iojs)
update name 2015-01-27 13:34:30 +08:00			3. `npm install konva`
update installation notes 2014-05-05 19:00:31 +08:00
move files 2015-01-09 23:45:45 +08:00			See file `resources/nodejs-demo.js` for example.
update installation notes 2014-05-05 19:00:31 +08:00
update readme 2015-01-09 20:51:36 +08:00			`#Change log`

update name 2015-01-27 13:34:30 +08:00			`See [CHANGELOG.md](https://github.com/konvajs/konva/blob/master/CHANGELOG.md).`
update readme 2015-01-09 20:51:36 +08:00
update installation notes 2014-05-05 19:00:31 +08:00			`#Dev environment`
Update README.md 2014-04-10 00:19:50 +08:00
Alpha nodejs support 2014-02-27 19:55:39 +08:00			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.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
update readme for new gulp builder. close #73 2015-05-04 17:15:16 +08:00			Run `gulp -T` to see all build options.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
update name 2015-01-27 13:34:30 +08:00			`##Building the Konva Framework`
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
update readme for new gulp builder. close #73 2015-05-04 17:15:16 +08:00			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`.
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
migrate to gulp 2015-04-07 16:03:08 +08:00			If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in `gulpfile.js`.
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00
update installation notes 2014-05-05 19:00:31 +08:00			`##Testing`
restructured unit tests and created a unit test build target which concatenates source test files 2012-11-14 13:37:28 +08:00
update name 2015-01-27 13:34:30 +08:00			`Konva uses Mocha for testing.`
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
update readme for new gulp builder. close #73 2015-05-04 17:15:16 +08:00			* If you need run test only one time run `gulp test`.
Update README.md 2015-11-05 22:19:13 +08:00			* While developing it is easy to use `gulp` default task with watch. Just run it and go to [http://localhost:8080/test/runner.html](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.
updated the readme with new test info 2013-09-11 12:51:07 +08:00
update name 2015-01-27 13:34:30 +08:00			`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.`
Kinetic.Animation constructor now just requires a function and optional node. No more config object 2012-11-16 13:30:58 +08:00
Update README.md 2014-08-25 23:16:56 +08:00			`##Generate documentation`
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
update readme for new gulp builder. close #73 2015-05-04 17:15:16 +08:00			Run `gulp api` which will build the documentation files and place them in the `api` folder.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00

bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00			`#Pull Requests`
update name 2015-01-27 13:34:30 +08:00			`I'd be happy to review any pull requests that may better the Konva project,`
update readme for new gulp builder. close #73 2015-05-04 17:15:16 +08:00			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`).