Skip to content

Commit

Permalink
markdown not textile
Browse files Browse the repository at this point in the history
  • Loading branch information
kumar303 committed Jul 13, 2012
1 parent 4366ae9 commit abd9df1
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 54 deletions.
70 changes: 70 additions & 0 deletions README.md
@@ -0,0 +1,70 @@
# Private Yacht

This is an [open web app](https://developer.mozilla.org/en/Apps/)
that provides you with a virtual private yacht.
Set sail!

The app is hosted right here on
[github pages](http://kumar303.github.com/yacht/)
but you must pay
for it on the
[Mozilla Marketplace dev site](https://marketplace-dev.allizom.org/app/private-yacht/)
(no real money is used on the dev site).

This is a demo of how to create a paid app for the Mozilla Marketplace
and how to use the JavaScript receipt checking library to verify the receipt.
Check out the
[receipt verifier library](https://github.com/mozilla/receiptverifier)
for more info on how to use it. This app invokes the library in
[www/js/app.js](https://github.com/kumar303/yacht/blob/master/www/js/app.js).

# WARNING

In a popular paid app you'd probably want to use a server side receipt checker,
like
[this one in Python](http://receipts.readthedocs.org/en/latest/).
Otherwise, an attacker can run your app in an apps-enabled browser
(such as the nightly build of Firefox) and fiddle with the JavaScript
using the console to gain access to the app. This would be harder to do
on Android, a B2G phone, or similar open web device.


# Mortar

The Private Yacht was built with [Mortar](http://jlongster.github.com/mortar).

"Mortar" is a code name for an Open Web App Bootstrap.
This project aims to make it easy and quick to start writing Open Wep Apps.

It's a combination of HTML5 tricks (HTML/CSS), js libraries, and
a little bit of management commands that make it really easy to write and deploy apps.

This should just be a template: you should download this and
hack it up to be whatever you like. You can delete or add as much stuff as you want.

View the official site [here](http://jlongster.github.com/mortar).

# html5boilerplate

This is a fork from the
[html5boilerplate](http://html5boilerplate.com/) project, and many of the HTML5
tricks come from there, so the appropriate authors deserve credit for those.

We don't need to target older browsers, however, so a bunch of IE 6/7
stuff has been removed and we've added things like marketplace libraries,
[require.js](http://requirejs.org/), and [volo](https://github.com/volojs/volo).
Any of those things can be simply ignored though.

h1. Back-end server

This is just a front-end template, but you'll most likely need to set up a
server for your app. I highly recommend the
[server-configs](https://github.com/h5bp/server-configs) project from the
h5b crew which provides really helpful templates for server configurations.
That should help you get set up quickly.

Apache's `.htaccess` file is already included here since that's the most popular.

# The End

This is very much alpha and will be fleshed out over time.
54 changes: 0 additions & 54 deletions README.textile

This file was deleted.

0 comments on commit abd9df1

Please sign in to comment.