Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moeriki/fx-kineticjs
Private duplicate KineticJS fork
https://github.com/moeriki/fx-kineticjs
Last synced: 22 days ago
JSON representation
Private duplicate KineticJS fork
- Host: GitHub
- URL: https://github.com/moeriki/fx-kineticjs
- Owner: moeriki
- Created: 2014-02-11T11:30:05.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T12:00:15.000Z (over 6 years ago)
- Last Synced: 2024-12-21T23:36:09.597Z (about 1 month ago)
- Language: JavaScript
- Size: 18.2 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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](https://travis-ci.org/ericdrowell/KineticJS.png)](https://travis-ci.org/ericdrowell/KineticJS)
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](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.
#NodeJS
Support of NodeJS is experimental.An nmp package is not yet published.
We are using (node-canvas)[https://github.com/LearnBoost/node-canvas] to create canvas element.
* You have to install node-canvas dependencies (https://github.com/LearnBoost/node-canvas/wiki/_pages)[https://github.com/LearnBoost/node-canvas/wiki/_pages]
* Run `npm install KineticJS`###Example
See file `nodejs-demo.js`.
#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`).