ratchet/README.md

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

2013-08-14 09:52:33 +04:00
# Ratchet v2.0 WIP
2012-11-05 04:03:39 +04:00
2013-10-26 15:57:39 +04:00
Prototype mobile apps with simple HTML, CSS, and JS components.
2012-11-05 04:03:39 +04:00
## Getting Started
- Clone the repo with `git clone https://github.com/maker/ratchet.git` or just [download](http://github.com/maker/ratchet/archive/v2.0.0.zip) the bundled CSS and JS
2013-10-09 02:20:36 +04:00
- [Read the docs](http://maker.github.io/ratchet) to learn about the components and how to get a prototype on your phone
2012-11-05 04:03:39 +04:00
- 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).
## Documentation
2013-10-19 20:04:46 +04:00
Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://maker.github.io/ratchet>. The docs may also be run locally.
### Running documentation locally
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation).
2. From the root `/ratchet` directory, run `jekyll serve` in the command line.
2013-10-19 20:04:46 +04:00
3. Open <http://localhost:4000> in your browser, and boom!
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
2012-11-05 04:03:39 +04:00
## Support
2013-10-19 20:04:46 +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](https://twitter.com/goratchet).
2012-11-05 04:03:39 +04:00
## Reporting bugs & contributing
2013-10-12 22:46:03 +04:00
Please file a GitHub issue to [report a bug](https://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
Connor Sears
2013-10-19 20:04:46 +04:00
- <https://twitter.com/connors>
- <https://github.com/connors>
2012-11-05 04:03:39 +04:00
2013-10-12 22:46:03 +04:00
Dave Gamache
2013-10-19 20:04:46 +04:00
- <https://twitter.com/dhg>
- <https://github.com/dhg>
2013-10-12 22:46:03 +04:00
2012-11-05 04:03:39 +04:00
Jacob Thornton
2013-10-19 20:04:46 +04:00
- <https://twitter.com/fat>
- <https://github.com/fat>
2012-11-05 04:03:39 +04:00
## License
2012-11-11 07:29:00 +04:00
Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).