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    

Platform Overview

A general overview of the Appery.io platform dashboard tabs and their main options

This document gives an overview of the main tabs of the Appery.io platform dashboard and introduces the general functions you might need when backing up or otherwise managing your data.

๐Ÿ‘

Video Tutorial: Appery.io Dashboard Overview

We highly recommend that you also check this detailed video guide covering the main features of the Appery.io platform:

Platform Overview: High-Level

When you sign up or log in, the Appery.io platform dashboard opens.
There are several tabs on it โ€“ Apps, Databases, Server code, Secure Proxy, API Express, Resources, and Account:

Apps Tab: Managing Projects

The Apps tab includes information about your projects, saved versions, people with whom you share the project, and about hosting on Appery.io. Here you can:

  • Create new projects.
  • Open, test, rename, update, and delete projects created earlier.
  • Make an app backup.
  • Create project versions and restore the old version of the project.
  • Invite people to share the project, or change the project owner.
  • Publish your project to your custom domain or Appery.io domain.

The left panel is the list of your apps with the labels indicating the framework the app was built with:

But if you are new to Appery.io, you will have no projects listed and will need to create your first app to see what's inside.

Create New App

To create a new app, click the Create new app button:

The modal window will open offering to select from the five tabs for creating a new app:

  • Ionic 4
  • Ionic 5
  • jQuery Mobile
  • Appery.io Templates
  • My templates
  • From backup

The first three tabs offer the selection between three popular frameworks that are currently supported by Appery.io.

A great way to start using Appery.io is to create your own app by using one of our ready-to-go customizable templates. You can learn more about Appery.io Templates here:

The My templates tab will show your projects that have been previously published as project templates (you can check this link to learn more about exporting projects as templates.)
Enter the app name (for example, NewIonic5App), select the needed tab (for example, Ionic 5) and click Create:

To create an app from a backup, switch to the From backup tab and select the project backup file. You can only upload an Appery.io project (exported as a backup).

๐Ÿšง

Maximum App Backup Size

Appery.io has a limitation for backups. The maximum app backup size you can upload is 60MB.
Therefore, you should be careful with the size of your applications (with a lot of local media files) and if your backup file size exceeds the max. app backup size that can be later re-uploaded. Before initiating the backup process, please check if your project contains large media files and delete them or reduce their size. Also, you can consider keeping them in the cloud and upload them to your project separately.
However, if the project size doesn't exceed this limit, you can be sure all your data will be kept safe.

More information about managing project backups can be found here:

The default Start page will open in the Appery.io Visual Builder:

Project Information

If you already have some projects and plug-ins created under your account, you can access them by selecting the needed app (or the previously created private plug-in).
The main app frame includes information about the selected project. Here, you can also switch between General, Push Notifications, Customer Console, and Permissions frames:

As you move the mouse over the project name, the Open button appears. Click it to open your project for editing (you will be redirected to Appery.io Visual Builder).

General Project Tab

The General frame consists of the following sections:

  • Project summary
  • Versions
  • Hosting
  • Webhooks
  • Share with support

Project summary

The Project summary section contains the project name and some related data. You can also see the different options available for managing this project (Open, Test, Rename, Delete, Backup, Update, and Remote Debug):

From this section, the project can be opened, tested, renamed, deleted, updated, debugged remotely (to activate this option, click the Enable Weinre debugging checkbox under the project App settings > General tab) or saved for later use (backed up) with further restoring it or even transferring to another account if necessary.

โ—๏ธ

Deleting cannot be undone later.

Versions

The Versions section contains information about versions of the project. This area contains the following information:

  • Reversed order number.
  • Creation date and time.
  • User who created the version.
  • Version comment.
  • Links to restore or delete the version. When you click any link, a pop-up opens where you can confirm or cancel the action.

In this section, you can create a version of your current project. Click New version to create a new app version. It is a good idea to enter a version comment to help you identify the version later.

Itโ€™s always a good idea to make app versions as you go along during your development so that you can experiment with your project safely.

Later, you will be able to go to the General tab, scroll down to the Versions section, restore the necessary app version, and create another project backup if needed.

๐Ÿšง

App Versions Number

The number of versions is plan-dependent, so check our Pricing table to learn how many versions can be created under your plan.

If you havenโ€™t created a version yet, the Versions area contains information about the current user, and the date and time the project was last saved.
To create a version, type the version name and click New Version.

๐Ÿ“˜

When you restore the version, youโ€™ll lose the changes made after the last version was saved. If you created a new version before restoring one of the earlier saved versions, no changes are lost and you can restore them later.

Hosting

The Hosting section allows you to publish your app. This area also contains information about the domains where the project was published.

This area has a field for Appery.io hosting โ€“ publishing to the custom domain and to the app_name.app.appery.io domain (for more detailed information check this link):

Using Publish, you can publish the app and update it after editing. Using Unpublish, you can stop hosting the app.

Webhooks

More information on Webhooks can be found here.

Share with support

The section Share with support is placed at the bottom of the page:

When a user shares (turns the toggle on), the specified resource appears in the admin section. This feature can be used by the support team for viewing and accessing all resources (apps, databases, server scripts, etc) shared.

When a user unshares (turns the toggle off), the specified resource canโ€™t be accessed for viewing by the support.

Making Project Backups

By making a backup of an app you can save all the created pages with their UI and services, enabled plugins, libraries versions, keys and binaries, themes, JavaScript, CSS, etc. The structure of the application also remains unchanged.

And all you need to do is to select an app under the Apps tab list, go to its General tab and click Backup:

A new window opens allowing you to select where you would like to save your backup.

๐Ÿšง

App Backups Number

The number of backups is plan-dependent, so check our Pricing table to learn how many app backups can be created under your plan.

Bundle Project Backup

If your app has integrated backend services like Databases, Server Code, API Express, or proxies, you can export this app bundle with all its dependencies. This allows making a full copy of the existing app in just a few clicks with keeping all the service settings and values in place.
With the option of creating a bundle project backup, there is no need to regenerate all the backend data anew.

๐Ÿšง

Note!

Please note that such custom dependent data like push configuration settings (certificates, etc.), Google Services JSON File, Firebase Admin SDK JSON File, API Express Security Providers, etc. are NOT added to the build and you will need to define them separately.

To generate the bundle project backup, select the needed app under the Apps tab list, go to its General tab and click Backup.
If your app has some backend, a new window will open and you will be offered to check the backup options you would like to save:

Now, all you need to do is select the backend services you would like to save with the project and confirm your selection.
You will see the message App export has been queued. You will be notified by e-mail when ready. After a while, you can check your inbox for the email with the link to the generated bundle project backup.

๐Ÿšง

Important Note!

Please be informed that the source application and the application you created from the backup will not be connected and not dependent on each other in any way.

Now, you are free to save it to your drive for further use or recreate the app with all its dependencies under the same account (so that you have two different working copies of the same app), or even create an app from this backup under a different Appery.io account.

โ—๏ธ

Note!

Please be aware that it is NOT recommended that you make any changes (for example, renaming or replace elements, etc.) to the exported backup file - this might result in a corrupt file with no possibility to unpack it in the future.

Creating from Project Backups

Later, when you decide to recreate your saved project, under the Apps tab, click Create new app. In the new window, select the From backup tab, enter the project name, choose the backup file saved on your drive, and confirm the action:

๐Ÿšง

Important note!

We highly recommend that you always save all your custom generated data like Apple provisioning profiles or those involving 3rd party Push notification providers like Firebase Cloud Messaging(FCM) and legacy Google Cloud Messaging (GCM).

Importing Saved Data Back

Importing other saved data is even easier.
Just select the appropriate tab (Apps, Databases, Server Code, or API Express) and click the green button Create new โ€ฆ.
In the new window, choose the previously saved backup file to be imported, name it, and hit Create.

๐Ÿšง

Important note!

Please be aware that you will need to make backups under the corresponding tabs and import them back under the same tabs.

Check below how to create a new database from a backup:

You will need to wait a bit and thenโ€ฆ
Congratulations! Youโ€™re done!

Managing Private Plug-ins

Under the Apps tab, you can also access the private plug-ins you created earlier:

๐Ÿ“˜

Find more details about how to work with private plug-ins in this document.

Platform Backend Tabs

The below tabs provide tools for setting up a backend for your Appery.io projects and the detailed information can be found under the corresponding links:

Databases tab stores app data;
Server Code is used for writing app logic on the server using JavaScript;
Secure Proxy is used for creating a service used for securing sensitive data such as an API key by keeping it only in the database and not in a mobile application;
API Express is used for exposing enterprise data sources such as an SQL database or SOAP service via REST APIs.

๐Ÿ‘

You can also click on the corresponding link in the App Visual Builder toolbar to be redirected to the corrsponding console: Database, Push, Server Code, or API Express:

Managing Account Resources

The Resources tab provides access to the resources saved under your account such as certificates, webhooks, and Cordova plug-ins. Selecting the corresponding tab allows access to the management options among which are exporting, exporting to ZIP, deleting, updating,
etc., depending on the resource selected:

๐Ÿ“˜

Find more details about how to work with:

Managing Appery.io Account Information

To view/update your account information, go to the Account tab:

There, many options are available such as changing/canceling plans, deleting the account, creating teams, purchasing support packs, etc. For more details, check here.

Updated 3 days ago

Platform Overview


A general overview of the Appery.io platform dashboard tabs and their main options

Suggested Edits are limited on API Reference Pages

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