Build Status

kimbo.js logo

An ECMAScript 5 only-compatible JavaScript library

The goal of this light-weight JavaScript library is to provide a nice, shorter and extended API using latest native compliant JavaScript and DOM APIs. Taking advantage of amazing native speed, of course only in modern browsers, and no more adding extra bytes for older ones.

Give it a try and start using a robust, light-weight and modern library today.

API Documentation

Please visit the documentation to see how easy is to use with its jQuery-like API.

Build

In order to run the build task you'll need NodeJS and Grunt.js.

After installing NodeJS, clone the project by running:

$ git clone git://github.com/dciccale/kimbo.js.git

Install grunt-cli:

$ npm install -g grunt-cli

Enter kimbo.js directory and install local dependencies:

$ cd kimbo.js && npm install

Now to run the full build task just run:

$ grunt

A dist/ folder will be created containing development and production build of kimbo.js including a source map file.

Running the Unit Tests

In the Browser

Run grunt coffee task to compile .coffee spec files and open test/SpecRunner.html.

$ grunt coffee && open test/index.html

In PhantomJS

Run grunt test and you will see the output.

$ grunt test

Developing

Run grunt watch to work with the library, build and tests will be run automatically.

$ grunt watch

Support

If you're having problems with using the project, use the support forum at CodersClan.

Current status

The current version is the first release that even it works pritty well, is still under heavy development. For now there isn't a browser compatibility table but have in mind it is intended for (and working) in modern mobile and desktop browsers.

Next steps

  • Increase code coverage (in progress)
  • Create gestures module
  • Create touch events module
  • Use XHR2 APIs

Follow @kimbojs on twitter to get the latest news.

Author

Denis Ciccale (@tdecs)

Thanks to Gonzalo Redondo Portero for making the logo

License

See LICENSE.txt

Bitdeli Badge

Share this project:

Updates