iPhone HTML5 Offline App Demo

Please post any mistakes or notes you have on the issues page (or fork me) and I'll add the necessary information.

Apple calls these "Web Clips" (online) or "Offline Applications" (offline).

git clone git://github.com/coolaj86/iphone-html5-offline-app-demo.git
cd iphone-html5-offline-app-demo

Node.JS server

You can use any web server. I'm not doing anything special with node here.

You just have to make sure that main.manifest loads with the mime-type text/cach-manifest

npm install spark
spark

Putting an Offline App on the Home Screen

Let's assume the ip address of your server is 192.168.1.100 running on port 3080.

You'll visit http://192.168.1.100:3080 and choose one of the apps and then add it to the Home Screen as follows:

iPhone

Click [->] icon in Safari
Select "Add to Home Screen"

Android

visit http://192.168.1.100:3080
Click menu
Click Bookmarks
Click Add
Exit to Home Screen
Click and Hold in empty space
Select Shortcut
Select Bookmark
Click the app
Shoot yourself... users will never be able to figure out all of these steps - I can barely do it!

Try the process of adding an app to your home screen right now with Backchannel: Offline Red Green App

Annotated Directory Structure of an app

From the document root

public/
    index.html

    // this is a tricky beast that maks the magic happen
    main.manifest


    // iOS 4.2 allows for various sizes and looks for these files in this order
    apple-touch-icon-114x114-precomposed.png
    apple-touch-icon-114x114.png
    apple-touch-icon-72x72-precomposed.png
    apple-touch-icon-72x72.png
    apple-touch-icon-57x57-precomposed.png
    apple-touch-icon-57x57.png

    // iOS 2.0 added support for precomposed images
    apple-touch-icon-precomposed.png

    // iOS 1.1.3 added support for icons
    apple-touch-icon.png

    // iOS 3 added support for startup screens
    apple-touch-startup-image.png

    pages/
        article1.html
        article2.html

    offline-assets/
        offline.html
        libs.js
        app.js
        logo.png
        style.css

    online-assets/
        search
        db.json
        auth

Note: It might be useful to store all assets which will be available offline in a folder called "assets" and write a script to walk the directory and produce the cache manifest (always with the current datestamp) including those assets. This will save you a lot of headache.

Cache Manifest

call this main.manifest. DO NOT call it cache.manifest (works in Chrome, not on iPhone)

CACHE MANIFEST
# That must be the very first line
# comments must be on their own line

# version 0.0.1
# bump the version any time you edit ANY of the CACHE assets
# otherwise they won't get updated when the app comes back online

CACHE:
# list ALL assets which should be downloaded for offline use
# no pattern matching is supported
/offline-assets/offline.html
/offline-assets/libs.js
/offline-assets/app.js
/offline-assets/logo.png
/offline-assets/style.css

FALLBACK:
# give the offline equivalent of a 404
# the first item is always treated as a prefix pattern
# the second is always treated as the resource to provide
/pages/ /offline-assets/offline.html
/ /offline.html

NETWORK:
# list any assets which are allowed to be fetched 
# from an online source even after the caching is complete
# can use * or prefix pattern matching
/online-assets/
http://www.google.com/api/search

Fun fact: You don't have to use \r\n in the Cache Manifest. \r and \n are also okay.

Resolutions

iPad

Native: 1024 x 768
Browser Mode:
- Landscape: 769 x 518
- Portrait: 768 x 946
HTML5 App Mode:
- Landscape: 1024 x 748
- Portrait: 768 x 1004

iPhone & iPod

Native: 480 x 320 @ 163 ppi (actually 960 x 640 @ 326 ppi)
Browser Mode:
- L: 320 x 356
- P: 320 x 139
HTML5 App Mode:
- L: 320 x 460
- P: 480 x 300
With Browser Debugger:
- L: 320 x 306
- P: 320 x 106

HTC Thunderbolt (4.3" Android 2.2)

Browser Mode (No App Mode):
- L: 369 x 546
- P: 615 x 300

Notes

Heachache Alert: Cannot Open MyApp MyApp could not be opened because it could not connect to the server.

With one mistake of the main.manifest you may end up in an error loop that you can't get out of without clearing the cache and renaming the app.

Solution:

Clear Mobile Safari's cache. Settings => Safari => Clear Cache
Rename your app <title>AppName</title>
You might also try renaming your URL. I.E. http://example.com/path/to/app to http://example.com/path/to/app2

How to avoid:

Test on Chrome until your app works, then on test your iPod / iPhone / iPad.
Particularly, always test your main.manifest in Chrome first.

Other Notes:

Develop on Chrome first - which has useful error messages - then test on Mobile Safari
The cache manifest may not be named cache.manifest. main.manifest works fine.
If there is an error in your cache manifest, your app will not update
- you delete a file that was listed
- you list a new file that doesn't exist
The cache manifest is NOT checked by modification date. It is checked bit-for-bit
The cache size is limited to 5mb

igordepaula / iphone-html5-offline-app-demo Goto Github PK