footwork

What is Footwork?

Footwork is a frontend framework based on KnockoutJS that aims to be fully featured, expressive, and easy to use while remaining as idiomatic and compatible with Knockout and its code base as possible.

It has features such as:

• Custom elements/components and declarative view models
• Automatic resolution and binding of declarative resources
• Page routing with unlimited outlet support
• Transition effect and animation system including sequenced animations
• Does not require a build system or module loader (but it works great with them)
• Inter-module communication and state sharing
• Much, much more...

For more details see:

• Main Website: http://footworkjs.com/
• Documentation: http://docs.footworkjs.com

Downloading / Installing Footwork

• You can install via bower:

  bower install footwork --save

• or you can install via npm:

  npm install footwork --save

• or you can download/use it directly via CDN:

  https://unpkg.com/footwork/dist/footwork.js

  https://unpkg.com/footwork/dist/footwork.css (optional, for animations)

For information on how to use FootworkJS please see the main website.

Issues

Please keep the issue tracker limited to bug reports, feature requests and pull requests. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue.

Contributing

Contributions are encouraged, please feel free to fork the repository and begin making changes.

General Flow

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request to the dev branch so that your changes can be reviewed

Submission Notes

• Please continue the coding style expressed in the rest of source.
• If creating a new feature, please also add the corresponding test(s) for it.
• In your pull-request, please do not include an updated dist/ build (generated via gulp dist), that is a final step done prior to release.

Website and Documentation Contributions

Contributions towards the website and/or documentation are also encouraged. There are companion repositories for both of these, please contribute to them directly:

• Website (http://footworkjs.com)

  https://github.com/footworkjs/footwork-website

• Documentation (http://docs.footworkjs.com)

  https://github.com/footworkjs/footwork-documentation

Building Footwork from source and running tests

1. Clone the repo from GitHub:

git clone https://github.com/footworkjs/footwork.git
cd footwork

1. Install Node.js and NPM (if needed):

This is platform specific. Your OS may already include it, however if not please see: Installing Node.

1. Install gulp globally (if needed):

sudo npm install -g gulp-cli

1. Acquire build dependencies:

npm install

1. Run a gulp task to build/test/etc:

• Build everything (output in /build):

  gulp

• You can include the ---debug option on any of the build/testing tasks to include/generate a source map in the output:

  gulp --debug

• Build everything and run tests (coverage report output in build/coverage-reports):

  gulp tests

• Watch for changes in the source code and automatically rebuild:

  gulp watch

• Watch for changes in the source code/tests and automatically rebuild + run tests:

  gulp watch-test

• Build everything, minify, and deploy to /dist (for release):

  gulp dist

• To debug the tests in your own browser:

  • Make sure your build is made without being instrumented for test coverage by running the default build task (otherwise debugging might be a bit difficult):

    gulp

  • Install karma (if needed)

    sudo npm install -g karma-cli

  • Start karma and then you can access/debug the tests from your browser at: http://localhost:9876/debug.html

    karma start

License

MIT license - http://www.opensource.org/licenses/mit-license.php