Build mobile apps with simple HTML, CSS, and JavaScript components.

Перейти к файлу

Zlatan Vasović 04bc296eec Change David badge theme to shields.io		2014-02-04 18:57:26 +01:00
_includes	fixing up the docs a bit	2014-01-28 21:34:49 -08:00
_layouts	homepage realign	2014-01-15 16:23:39 -08:00
dist	popover padding	2014-02-01 22:24:30 -08:00
docs-assets	fix ios popovers	2014-02-01 22:21:17 -08:00
examples/app-default	do away with attribute selector	2014-01-31 18:09:36 -08:00
lib	popover padding	2014-02-01 22:24:30 -08:00
.gitignore	Remove folders of other scm's from gitignore	2013-09-27 18:22:09 +02:00
CONTRIBUTING.md	Add note about editing dist files	2013-10-16 20:21:20 +02:00
Gruntfile.js	Merge branch '2.0.0-wip' into docs-rework	2014-01-29 10:56:40 -08:00
LICENSE.md	Fix license	2013-10-12 23:15:46 +02:00
README.md	Change David badge theme to shields.io	2014-02-04 18:57:26 +01:00
_config.yml	Reorganizing the docs files and breaking things.	2013-10-13 15:00:38 -07:00
component.json	Updating version numbers.	2013-08-04 17:10:42 -07:00
components.html	center the btn	2014-02-01 16:53:29 -08:00
favicon.ico	Jekyll the docs.	2013-09-22 22:05:41 -07:00
getting-started.html	Reorganizing the docs files and breaking things.	2013-10-13 15:00:38 -07:00
index.html	use .btn	2014-01-31 17:32:16 -08:00
one.html	remove chevron.scss and just use icons now. \o/	2014-02-01 16:34:58 -08:00
package.json	update dependencies	2014-01-28 20:46:23 -08:00
two.html	making the docs a little less jank	2013-12-21 14:48:48 -08:00

README.md

Ratchet v2.0 WIP

Prototype mobile apps with simple HTML, CSS, and JS components.

Getting Started

Clone the repo with git clone https://github.com/maker/ratchet.git or just download the bundled CSS and JS
Read the docs to learn about the components and how to get a prototype on your phone
We will have example apps to check out very soon!

Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the tagged downloads.

Documentation

Ratchet's documentation is built with Jekyll and publicly hosted on GitHub Pages at http://maker.github.io/ratchet. The docs may also be run locally.

Running documentation locally

If necessary, install Jekyll.
From the root /ratchet directory, run jekyll serve in the command line.
Open http://localhost:4000 in your browser, and boom!

Learn more about using Jekyll by reading its documentation.

Support

Questions or discussions about Ratchet should happen in the Google group or hit us up on Twitter @GoRatchet.

Reporting bugs & contributing

Please file a GitHub issue to report a bug. When reporting a bug, be sure to follow the contributor guidelines.

Troubleshooting

A small list of "gotchas" are provided below for designers and developers starting to work with Ratchet

Ratchet is designed to respond to touch events from a mobile device. In order to use mouse click events (for desktop browsing and testing), you have a few options:
- Enable touch event emulation in Chrome (found in the overrides tab in the web inspector preferences)
- Use a javascript library like fingerblast.js to emulate touch events (ideally only loaded from desktop devices)
Script tags containing javascript will not be executed on pages that are loaded with push.js. If you would like to attach event handlers to elements on other pages, document-level event delegation is a common solution.
Ratchet uses XHR requests to fetch additional pages inside the application. Due to security concerns, modern browsers prevent XHR requests when opening files locally (aka using the file:/// protocol); consequently, Ratchet does not work when opened directly as a file.
- A common solution to this is to simply serve the files from a local server. One convenient way to achieve this is to run python -m SimpleHTTPServer <port> to serve up the files in the current directory to http://localhost:<port>

Authors

Connor Sears

Dave Gamache

Jacob Thornton

License

Ratchet is licensed under the MIT License.