Peter Cottle
3d0f6bed37
|
12 years ago | |
---|---|---|
dist | 12 years ago | |
docs | 12 years ago | |
lib | 12 years ago | |
test | 12 years ago | |
.gitignore | 12 years ago | |
CONTRIBUTING.md | 12 years ago | |
LICENSE | 12 years ago | |
Makefile | 12 years ago | |
README.md | 12 years ago | |
component.json | 12 years ago |
README.md
Ratchet
Prototype mobile apps with simple HTML, CSS and JS components.
Getting Started
- Clone the repo
git clone git@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.
Support
Ratchet was developed to support iOS 5+ for iPhone. 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 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 (depending on the user agent)
- 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.
Future features
Ratchet is just getting started. Here are some of the immediate features we're thinking about:
- Shelf (exposable left hand navigation a la Path or Facebook)
- Gridviews
- Notifications
- Slide control
- More list views options
- Improved active states (especially for lists)
- Docking list dividers
- Touch library for richer touch events (swipes, long press, etc)
- Autocomplete
- Hiding title bar (hides with scroll)
Even these are just the short-term goals though. We eventually want to extend Ratchet beyond the prototying for iPhone and create HTML/CSS/JS components for iPad and Android devices. Our dream is that Ratchet becomes the best way to create mobile experiences with web standard languages.
Authors
Dave Gamache
Connor Sears
Jacob Thornton
License
Ratchet is licensed under the MIT License.