twbs/ratchet

Ratchet is a small toolkit from the Bootstrap team for building mobile apps using only HTML, CSS, and JavaScript. The idea, as stated in the README, is that someone can put together a prototype of a phone app using regular web-page building blocks instead of native iOS or Android tools. The project lives at goratchet.com, where the docs and examples are hosted. To start, you either clone the Git repository or download a bundled zip. Inside the download you get a folder with three groups of files: a css folder containing the main Ratchet stylesheet plus optional Android and iOS themes, a js folder containing the Ratchet JavaScript, and a fonts folder containing an icon font called Ratchicons. Each CSS and JS file ships in both a normal and a minified version. The README warns that the master branch is active development and recommends grabbing a tagged release for stable use. The documentation is written with Jekyll and published on GitHub Pages. You can also run the docs locally by installing Jekyll, installing a Ruby syntax highlighter called Rouge, then running jekyll serve from the project root and opening localhost:4000 in a browser. There are notes about where to find docs for older releases. A troubleshooting section flags a few practical gotchas. Ratchet is built around touch events, so on a desktop browser the mouse will not trigger them unless you enable touch emulation or use a helper library. Inline script tags do not run on pages loaded by Ratchet's push.js page loader, so event handlers should be attached at the document level. And because Ratchet fetches additional pages via XHR, opening the files directly from the file system fails on modern browsers, so the README suggests serving the folder from a simple local HTTP server. The rest of the README covers semantic versioning, the maintainers (Connor Sears, with original credit to Dave Gamache and Jacob Thornton), and an MIT license notice.