ratchet/README.md

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

2014-02-25 09:17:57 +04:00
# Ratchet v2.0 [![devDependencies](https://david-dm.org/twbs/ratchet/dev-status.png?theme=shields.io)](https://david-dm.org/twbs/ratchet#info=devDependencies)
2012-11-05 04:03:39 +04:00
2014-02-17 09:12:54 +04:00
Build mobile apps with simple HTML, CSS, and JS components.
2012-11-05 04:03:39 +04:00
## Getting Started
2014-02-25 08:25:00 +04:00
- Clone the repo with `git clone https://github.com/twbs/ratchet.git` or just [download](http://github.com/twbs/ratchet/archive/v2.0.0.zip) the bundled CSS and JS
- [Read the docs](http://goratchet.com) 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!
2014-02-25 08:25:00 +04:00
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/twbs/ratchet/tags).
## Documentation
2014-02-25 08:25:00 +04:00
Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://goratchet.com>. The docs may also be run locally.
### Running documentation locally
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation).
- **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. We use Pygments for syntax highlighting, so make sure to read the sections on installing Python and Pygments.
2014-02-25 07:51:12 +04:00
2. From the root `/ratchet/docs` directory, run `jekyll serve` in the command line.
- **Windows users:** While we use Jekyll's `encoding` setting, you might still need to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors. For Ruby 2.0.0, run `chcp 65001` first. For Ruby 1.9.3, you can alternatively do `SET LANG=en_EN.UTF-8`.
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
2014-01-29 10:13:44 +04:00
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
2014-02-25 08:25:00 +04:00
Please file a GitHub issue to [report a bug](https://github.com/twbs/ratchet/issues). When reporting a bug, be sure to follow the [contributor guidelines](https://github.com/twbs/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
2014-02-26 01:09:27 +04:00
## Maintainers
2012-11-05 04:03:39 +04:00
Connor Sears
2013-10-19 20:04:46 +04:00
- <https://twitter.com/connors>
- <https://github.com/connors>
2014-02-25 22:47:20 +04:00
2014-02-25 22:46:14 +04:00
Connor Montgomery
2012-11-05 04:03:39 +04:00
2014-02-25 22:46:14 +04:00
- <https://twitter.com/connor>
- <https://github.com/connor>
2013-10-12 22:46:03 +04:00
2014-02-25 22:46:14 +04:00
Created by Connor Sears, Dave Gamache, and Jacob Thornton.
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).