Documentation | Appery.io

The Appery.io Developer Hub

Welcome to the Apperyio developer hub. You'll find comprehensive guides and documentation to help you start working with apperyio as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    

Private Plug-ins

Exporting private plug-ins

Introduction

Any part of an app (client) you are building can be exported as a plug-in. A plug-in can then be imported into any other app along with out-of-the-box Appery.io plugins.
Think of this as creating reusable app components. For example, you can create an app with one page and one service which sends an email. You can export it as a plug-in and then add this functionality (one page, one service) into another app.

Creating Private Plug-ins

To create a private plug-in that you can later use in your projects, simply build any app and export it (or its parts) as a plug-in.

Example

Follow the steps below to export an app as a private plug-in.

  1. Build an app that you want to export as a plug-in. You don’t need to build a complete working app, you can create pages or services and export them as a plug-in.
  2. To export this app as a plug-in click Export in the upper dashboard and select Appery.io plugin:
  1. Perform the following steps (some are optional):
  • Upload the plug-in’s icon image.
  • Set the plug-in’s name.
  • Set the plug-in’s description.
  • Provide an API home page and documentation site.
  • Set the plug-in version.
  • Pick one or more categories.
  • Set the API vendor.
  1. By default, the entire project is exported as a plug-in.
  2. If you need to export just parts of the app into the plug-in (only pages or specific services), uncheck the Export entire project checkbox. You’ll receive an option to select which app file you’d like to export into the plug-in:
  1. Click Export to finish creating the plug-in:

When ready, it should appear on the plug-ins list in the left view of the Apps tab:

Plug-ins list

You can see all the plug-ins (private) you have created, under the Plugins section:

There, you can find information about the plug-in (creator e-mail, publicity, import counter value, and so on) and:

  • Open the plug-in to edit it.
  • Rename the plug-in.
  • Delete it.
  • Backup it.

Updating Plug-in

There are three ways to update a plug-in:

  1. Create a new plug-in.
  2. Open the plug-in and edit it.
  3. Replace the plug-in with a new version.

When creating a new plug-in, you lose the Import counter value (the new plug-in doesn’t inherit this value from the old one). If you open and edit the plug-in, someone can import it when you haven’t finished working on it – it is unsafe. The safest way is to replace the plug-in with a new version.

To replace the plug-in with a new version:

  1. Open the project your plug-in was created from, or recreate a project with the same features.
  2. Make changes in the project and check that it works correctly (debug).
  3. Select Export > Appery.io plugin.
  4. In the Export plugin tab, check the Replace plugin box.
  5. In the pop-up, check the plug-in you are going to replace and click Import selected plugins.
  6. Change the version of the plugin. Other properties can also be updated. Make sure the additional options’ boxes are checked correctly.
  7. Click Replace.

Your plug-in will be replaced instantly, and the import counter will be kept.

Publish as App Template

Any project can also be published as a project template. To export your project as a project template check the Export entire project and Add this plugin as project template options and export it:

📘

Exporting Project

To export it as a project template, Export entire project must be selected.

To create a new app based on a project template:

  1. Click Create new app from the Apps tab, go to the My templates tab, select the project template, and click Create:
  1. Later, in the app Project view, you can go to the CREATE NEW > From Plugin. This will open a new window with your created project template listed there as well (with Project template: yes) and that can be imported into your app:

To quickly find the needed plug-in, start typing its name or group all plug-ins by the vendor. By default, they are grouped by Category.

Creating Public Plug-ins

If you would like to make your plug-in public and available to the entire Appery.io user community, please contact [email protected]. We will review the plug-in and publish it.

Updated 3 months ago

Private Plug-ins


Exporting private plug-ins

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.