ratchet/README.md

53 строки
2.7 KiB
Markdown
Исходник Обычный вид История

2013-08-14 09:52:33 +04:00
# Ratchet v2.0 WIP
2012-11-05 04:03:39 +04:00
Prototype mobile apps with simple HTML, CSS and JS components.
## Getting Started
2012-11-05 11:43:37 +04:00
- Clone the repo `git clone git@github.com:maker/ratchet.git` or just [download](http://maker.github.com/ratchet/ratchet.zip) the bundled CSS and JS
2012-11-05 04:03:39 +04:00
- [Read the docs](http://maker.github.com/ratchet) 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](https://github.com/maker/ratchet/tags).
2012-11-05 04:03:39 +04:00
## Support
2013-09-23 08:27:58 +04:00
Ratchet was developed to support iOS 7+ for iPhone. Questions or discussions about Ratchet should happen in the [Google group](https://groups.google.com/forum/#!forum/goratchet) or hit us up on Twitter [@goRatchet](http://www.twitter.com/goratchet).
2012-11-05 04:03:39 +04:00
## Reporting bugs & contributing
2013-04-08 12:28:45 +04:00
Please file a GitHub issue to [report a bug](http://github.com/maker/ratchet/issues). When reporting a bug, be sure to follow the [contributor guidelines](https://github.com/maker/ratchet/blob/master/CONTRIBUTING.md).
2012-11-05 04:03:39 +04:00
2012-11-11 07:29:00 +04:00
## Troubleshooting
A small list of "gotchas" are provided below for designers and developers starting to work with Ratchet
2012-11-11 07:29:00 +04:00
- 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)
2012-11-11 07:29:00 +04:00
- 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>```
2012-11-11 07:29:00 +04:00
2012-11-05 04:03:39 +04:00
## Authors
Dave Gamache
- http://twitter.com/dhg
2013-08-08 20:46:28 +04:00
- http://github.com/dhg
2012-11-05 04:03:39 +04:00
Connor Sears
- http://twitter.com/connors
- http://github.com/connors
Jacob Thornton
- http://twitter.com/fat
- http://github.com/fat
## License
2012-11-11 07:29:00 +04:00
Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).