playground
/
ratchet
mirror of https://github.com/twbs/ratchet.git
1
0
Fork 0
Code Issues Releases Activity
Build mobile apps with simple HTML, CSS, and JS components. http://goratchet.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
191 Commits
4 Branches
6 Tags
15 MiB
Tree: e357738033
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e357738033'
${ noResults }
connors e357738033
Derpin with font weights 		11 years ago
dist Derpin with font weights 11 years ago
docs minor refinements 11 years ago
lib Derpin with font weights 11 years ago
test Counts use variables 11 years ago
.gitignore rmeove dist from gitignore 12 years ago
CONTRIBUTING.md first commit 12 years ago
Gruntfile.js Comments and style change to sass 11 years ago
LICENSE first commit 12 years ago
README.md Updating readme 12 years ago
component.json Updating version numbers. 12 years ago
package.json Setting up basic variables. 11 years ago

README.md

Ratchet v2.0 WIP

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 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

Dave Gamache

Connor Sears

Jacob Thornton

License

Ratchet is licensed under the MIT License.