ease-framework
Ease is a framework for creating keyboard navigated applications.
Last updated 2 years ago by sixtyno .
SEE LICENSE IN LICENSE · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install ease-framework 
SYNC missed versions from official npm registry.

Ease Framework 3

Ease Framework is a high-performance, component-based framework built in CoffeeScript. It enables maximum reusability and can significantly accelerate your application development process.

CircleCI Issue Count

Files

  • src: The Ease Framework
  • docs: Documentation (the same as you find on ease.coffee)
  • test: Mocha test files
  • build-dependencies: Tasks and helpers for the build system (Grunt)

Running the tests

You will need Node.js 4+. Simply run npm install && npm test

Documentation

To read the documentation you have two options.

Hosted documentation

Note that you will need to authenticate for access to the hosted documentation. Contact Sixty if you need access.

You will always find the latest Ease Framework 3 documentation at http://ease3.ease.coffee. If you need the documentation for a specific version, starting from v3.1.0, you can find it by navigating directly to the version tag in your url.

http://ease3.ease.coffee/BRANCH/docs
http://ease3.ease.coffee/VERSION/docs

Local documentation

If you want to open up the documentation locally, you can do so with the help from the npm packages codo and quickserver.

Our documentation is written in MDWiki in general. We use codo to generate the API documentation automatically from inline comments. In this way, our documentation will always follow our repository and be deployed along with our code.

To open the documentation locally, use your terminal:

$ npm install -g codo quickserver   # Install dependencies
$ codo                              # Generate the documentation
$ quickserver                       # Start the server

You will then be able to open the documentation at http://localhost:8888/docs/, where you can navigate into the API documentation created by Codo

Current Tags

  • 3.3.2                                ...           latest (2 years ago)

1 Versions

  • 3.3.2                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (38)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |