--- layout: default title: Getting started · Ratchet ---
{% include masthead.html %}

Getting started

Once you've downloaded Ratchet, here's what to do next.

{% include ad.html %}

  1. 1. Create your pages

    Use the documentation as a reference for all the available components and piece together the pages of your app. Be sure to look at the basic page template and example applications. Make sure to add ratchet-theme-ios.css or ratchet-theme-android.css to your app's <head> if you have a specific platform in mind.

  2. 2. Connect pages with push.js

    Read about push.js then start connecting your pages. Push.js allows you to create a prototype that feels like a real app when you save it to your phone. (Need to have a server running).

  3. 3. Save the prototype to your phone

    There are a few ways to do this, but the simplest is to run a local server on your computer, point Safari on your iPhone to your computer, then click the button and "Add to Home Screen". For Android, check out this guide.

Page setup

Three simple rules for structuring your Ratchet pages

  1. 1. Fixed bars come first

    All fixed bars (.bar) should always be the first thing in the <body> of the page. This is really important!

  2. 2. Everything else goes in .content

    Anything that's not a .bar should be put in a div with the class .content. Put this div after the bars in the <body> tag. The .content div is what actually scrolls in a Ratchet prototype.

  3. 3. Don't forget your meta tags

    They're included in the template.html page included in the download, but make sure they stay in the page. They are important to Ratchet working just right.

Basic template

Use this basic template to get your app started.

{% highlight html %} Ratchet template page

Ratchet

Thanks for downloading Ratchet. This is an example HTML page that's linked up to compiled Ratchet CSS and JS, has the proper meta tags and the HTML structure. Need some more help before you start filling this with your own content? Check out some Ratchet resources:

{% endhighlight %}

Community

Stay up to date on the development of Ratchet and reach out to the community with these helpful resources.

  1. Read and subscribe to The Official Bootstrap Blog (which includes Ratchet releases and news).

  2. For help using Ratchet, ask on StackOverflow using the tag ratchet-3.

  3. Start a discussion on the Ratchet Google group.

You can also follow @goratchet on Twitter for the latest news.

{% include download-module.html %}
{% include footer.html %}