Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 2.45 KB

README.md

File metadata and controls

49 lines (27 loc) · 2.45 KB
Raw

#KineticJS has Retired

Hi all! It's been awhile since I've worked on KineticJS, and I've since moved on to other projects. KineticJS is still an awesome HTML5 Canvas library, so I will be keeping the source in github indefinitely (as long as there is a github). However, I will no longer be fixing issues or responding to questions. Please feel free to fork the repo if you'd like to make changes.

Also, you can now find tars of every stable KineticJS build on www.kineticjs.com

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

  1. Install node-canvas https://github.com/LearnBoost/node-canvas/wiki/_pages
  2. npm install jsdom
  3. 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

Build Status

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.

##Generate documentation

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