Publish an app on the Frappe Cloud Marketplace

Publish your Frappe app on the Frappe Cloud Marketplace, so that Frappe Cloud users can install it on their
sites in a few clicks. You add the app from GitHub, complete its listing, and send it for review. The Frappe
Cloud team reviews it and then publishes it.

The full process has five parts:

1. Prepare your app.
2. Become a publisher.
3. Add your app.
4. Complete the listing.
5. Send the app for review.

1. Prepare your app

Before you start, make sure that your app meets these requirements. The review team rejects apps that do not.

• Open source. The app is licensed under MIT or a license compatible with the GNU General Public License
  (GPL). See the GPL-compatible licenses
  on gnu.org.
• On GitHub, owned by you, and public. The dashboard does not accept a private repository.
• A unique app name. No other Marketplace app can have the same name, even if your app is not a fork of
  it. The app name is the app_name in your app's hooks.py.
• Current stable version. The app works with the current stable version of Frappe Framework, and of
  ERPNext if it depends on ERPNext.
• A passing CI. The repository has a GitHub Actions (or similar) workflow for tests and linters, and it
  passes. See App authoring guidelines.

2. Become a publisher

You do this one time for your Frappe Cloud team.

1. Log in to the Frappe Cloud dashboard.
2. Go to Settings › Profile.
3. In Become Marketplace Developer, click Become a Publisher, and confirm.

A Marketplace item shows in the sidebar. This is not the same as developer mode on a Frappe site.

3. Add your app

1. In the sidebar, click Marketplace.
2. Click New App. The Add a new Marketplace App dialogue opens.
3. Click Add from GitHub, and authorise Frappe Cloud to read your GitHub account if it asks.
4. Select the repository and the branch.

Frappe Cloud checks that the repository is a valid Frappe app. If it is, you see Found <app title>
(<app name>). Frappe Cloud finds the compatible Frappe version automatically.
5. Click Add App.

The app page opens. The app status is Draft. Customers cannot see the app until it is published.

If Add App stays disabled with "The GitHub repository is private", make the repository public, and
then select it again.

4. Complete the listing

On the app page, click Complete Listing. The dialog shows the four steps that must be done before you
can send the app for review, with a check mark next to each completed step.

Also on the Listing tab:

• Title: the name shown on the Marketplace, up to 255 characters. It can differ from the app name.
• Screenshots and Videos: screens of your app. Put screenshots here, not in the long description.

For the full listing rules, see Guidelines for publishing an app.

Paid apps

To sell the app, add plans on the Pricing tab, then set your payout method. See
App Pricing Plans and Payouts.

5. Send the app for review

1. On the app page, click Complete Listing.
2. When all four steps have a check mark, click Mark app ready for review.

The status changes to In Review. The Frappe Cloud team checks the app for security, code quality and these guidelines. The automated checks are on the Audit Reports tab. The team can also ask you for a short demo video that shows how to use the app.

When the team approves the app, it is published, and it gets its own page on the Marketplace. Click
View in Marketplace to open it.

The review takes up to 10 days. If the app is still In Review after 10 days, raise a ticket on the
Support Portal.

You can also view an app’s “Audit Report" directly on the Frappe Cloud Dashboard. The report highlights issues that need to be fixed. Once the Semgrep Scan finds no serious security gaps or other issues, the app is ready for a personalised review by the Frappe Cloud team.

After publishing

Each time you push code to the branch, a new release is created. Submit it from Versions ›
Show Releases to publish it. See Managing your Marketplace App.

Related

• Frappe Cloud Marketplace overview
• Guidelines for publishing an app
• App authoring guidelines
• Payouts