So you've coded a Quickstart and are ready to share it with the world…and maybe even make some money off it? Awesome! It's easy. This guide will walk you through publishing your Quickstart. After reading it, you should be familiar with:
- The Quickstart Publication Process
- Configuring Quickstart details
- The different ways to share your Quickstart
- Making money from your Quickstart
Registering Your Quickstart
Once you're ready to publish your Quickstart, go to your App Dashboard and under "My Quickstarts," click New Quickstart. All you'll need is a Quickstart name and the Git Clone URL of your Quickstart Repo. Once those are entered, click "Create & Edit" and your Quickstart will be registered.
Any public or private Git Repo can be used to house your Quickstart Repo, but Pagoda Box must be a collaborator on private repos. If it's a private Repo on Github, you'll need to add "pagodabox" as a collaborator. For other private repos, just add Pagoda Box's public SSH Key to the repo.
SSHPagoda Box Public SSH Key
Once your Quickstart is registered, there's a lot of required and optional information you can provide. Here's just a quick rundown of those details.
Short Description: Shows up on the Quickstart List Page and Quickstart Search Results. It should be descriptive, short, and sweet. You only have 40 characters.
Long Description: Appears on your Quickstart Project Page and in your Quickstart Quick View display. Feel free to make this description as long as it needs to be.
Resources: This are links related to your Quickstart that appear on your Quickstart Project Page and Quick View. Feel free any custom resources you would like. Custom resources only appear on your Project page.
You can upload a custom avatar for your Quickstart.
Public: Your Quickstart is visible to everyone and will appear in the public Quickstart List and search results.
Unlisted: Your Quickstart is only available to those who have a direct link to your project page. It will not appear in the public Quickstart List or search results.
Private: Your Quickstart is only viewable to you and your Quickstart Contributors. By default, Quickstart's visibility are set to private when they are created.
Password Protection: Any Quickstart can be password protected. Password protected Quickstarts require a password to be launched, but not to be viewed.
Every Quickstart must have a license associated with it. By default, it's the MIT Open-Source license, but you can use any Opensource or Propriety license you would like.
You can also require that users agree to your User Agreement before they launch the Quickstart.
Adding contributors allows you to show who's involved in the project. Contributor Gravatars are displayed on the Quickstart Project Page. You can also give contributors Admin rights, which allows them to edit any Quickstart details.
You can share your Quickstart with the community for free or specify a price. For more information about payouts and refunds, check out our Legal Pages.
Search tags help Pagoda Box users to find your Quickstart through a Quickstart search. You only get 6, so use them wisely.
Releases allow you to specify a commit within your Quickstart repo to use as the active version. Commit IDs can be used from any branch. The active version number/name appears on your Quickstart Project Page. If no Release is specified as the active version, it will default to the latest commit on the master branch of your repo.
We give you a percentage of what's billed to apps launched from your Quickstart along with a percentage of any specified fees. We just need a PayPal ID to send the money to. Check out our Payout Policies.
Under the admin section, you can delete your Quickstart. Once a Quickstart is deleted, you will not longer receive payouts associated with applications launched from your Quickstart.
Sharing Your Quickstart
We want to help you get the word out about your Quickstart, so we've baked in a couple of different ways to to share it.
Quickstart Project Page
Each Quickstart has it's own Project Page, viewable by Pagoda Box users and non-users alike (depending on your visibility settings). It's meant to act as a home for anyone who is interested in learning more about your Quickstart. Feel free to share it with the world.
Social Media Sharing
Each Quickstart Project Page includes the good ol' social media sharing buttons. Nothing too out of the ordinary here, but they do go a long way in helping get the word out.
Public Launch URLs
Public Launch URLs allow users to launch your Quickstart from anywhere on the interwebs. Once a user clicks or navigates to your Public Launch URL, an new app will automatically be launched from your Quickstart. If someone isn't currently a Pagoda Box user, all they'll need to do is create an account, and their app will launch. Your public launch URL can be found on your Quickstart Edit Page and Project Page.
Remember that you get a percentage of what's billed to apps launched from your Quickstart, so the more apps launched, the higher your earning potential.