DOCS
Every time that you change the App settings you must publish it, so you can see the changes applicated in the store and in the users devices.
Getting Started with My Apps
Fawi
Fawi it's a framework used to publish and access Full Apps Without Installations.
Fawi works with two different environments, the Fawi Office used to publish and manage apps and the Fawi Store where users can access the published Fawi Apps.
Fawi Apps
A Fawi App is a combination between a Web Link and Fawi Platform. So you can develop any Web App (html, css, javascript) using a single codebase, combined with Fawi Native resources (optional), and Publish in Fawi through Fawi Office, providing users cross platform apps without installations and with native full experience through Fawi Store.
Already have an app?
If you already have Apps developed in the next platforms follow the next tutorials to Publish in Fawi:
Publish in Fawi
To publish a new app please follow the next steps:
- In the Office menu "My Apps" click on the bottom right button;
- Fill out the form of your new app and save;
- Done! Now your new app is ready to be configured in the Publish Settings.
App Name
Defines the short name and the long name of the application. The short name will be used in the app device data, the long name will be used in the Fawi Store and both can be the same.
NOTE: The short name and the long name should fill the Fawi Terms requirements.
Publication Mode
Defines who can access the app [Public/Restricted]. The Public option lets anyone use the app and the Restricted option requires you to set your Restricted Users, in app main menu in Fawi Office.
NOTE: For users to have access to the Restricted Apps, they need to enable the option in the "Settings > Advanced > Restricted Apps" menu in Fawi Store.
Categories
Select wich categories the app belongs [Main / Secondaries].
NOTE: You can select a maximum of one main category and five secondary categories. The categories must be related to their utility and type of the app.
Parental Control
Select the minimum age to restrict the app users.
NOTE: This information should fill the Fawi Terms requirements and will be used to assist parents in Fawi Store, in their ability to restrict which contents can be seen by their children.
Main Language
Select the main language used by the app.
Regions
Select the countries where this app is supported.
Publish Settings
In this App menu section you can define all the configurations before publish.
Icon
Upload your application icon, 500px X 500px recommended, with a better design. The app color will be automatically generated, but it can be changed.
NOTE: The icon should be something flashy, related to the application category to attract many users and it should fill the Fawi Terms requirements.
Settings
Change your app settings any time.
App Name
Defines the short name and the long name of the application. The short name will be used in the app device data, the long name will be used in the Fawi Store and both can be the same.
NOTE: The short name and the long name should fill the Fawi Terms requirements.
Publication Mode
Defines who can access the app [Public/Restricted]. The Public option lets anyone use the app and the Restricted option requires you to set your Restricted Users, in app main menu in Fawi Office.
NOTE: For users to have access to the Restricted Apps, they need to enable the option in the "Settings > Advanced > Restricted Apps" menu in Fawi Store.
Categories
Select wich categories the app belongs [Main / Secondaries].
NOTE: You can select a maximum of one main category and five secondary categories. The categories must be related to their utility and type of the app.
Parental Control
Select the minimum age to restrict the app users.
NOTE: This information should fill the Fawi Terms requirements and will be used to assist parents in Fawi Store, in their ability to restrict which contents can be seen by their children.
Main Language
Select the main language used by the app.
Regions
Select the countries where this app is supported.
Server
The server settings allows you to edit the application link.
App URL
Defines the App URL and the App Index File [optional].
NOTE: Your application link should be "https://"
App Keys
The Public and the Secret keys are automatically generated when the app is created, but they can be reseted. They'll be used to request Fawi API using the Public Key in client side and the Secret Key in server side.
Basic Authentication
If your app hosting server uses Basic Authentication security you need to add the credentials [Username/Password] to allow Fawi access.Learn More
In the App URL you need to verify that you own the link using one of the methods below:
- Using validations files:
- Download the validation files;
- Upload the validation files to the "https://app_url/root_folder".
- Click on the "Validate URL" button to execute the validation.
- Adding <meta> tag:
- Copy the Fawi validation meta tag to your App home page.
- Add <meta> tags in WordPress
- Add <meta> tags in Wix
- Add <meta> tags in Ghost
- Add <meta> tags in Shopify
- Add <meta> tags in Joomla
- Add <meta> tags in Jimdo
- Add <meta> tags in Blogger
- Add <meta> tags in Squarespace
- Add <meta> tags in Drupal
- Add <meta> tags in Weebly
- Add <meta> tags in Carrd
- Add <meta> tags in TYPO3
- Add <meta> tags in HubSpot
- Add <meta> tags in PrestaShop
- Add <meta> tags in Grav
Fawi gives you some validation files containing a verification public key to validate your domain. When you upload the validation files to your web server, we check that it's there. Uploading the file doesn't affect your App:
NOTE: The validation files must be available at your domain root folder in the online App version and not limited to an internal localhost (an intranet). For example, "https://app_url/main_folder".
Example of tag:
<!DOCTYPE html>
<html lang="en">
<head>
...
<meta name="fawi-url-validation" content="app_public_key">
...
</head>
NOTE: Here are some tutorials if you use CMS to make your app:
Info
Provide all details that your users need to know about your application.
Youtube Video Link
A link to a youtube video that shows the app running. [Optional]
Description
Show the user some info about the app and how it works.
Prints
Show the user interface experience, uploading some prints of your application.
NOTE: To publish your App you need to upload at least one image to show the user interface.
App Version
Current development version of the app.
In-App Purchase
Specifies if this app contains payed services.
In-App Ads
Specifies if this app contains advertisements.
Developer
The developers of the application.
Publisher
Some info of the app publisher.
NOTE: The "Developer" and the "Publisher" can be the same. The "Publisher" Web Site and Terms URL are optional, but if filled they need to be validated as same as the App URL.
Locals
In case the app belongs to the "Local" category, normally intended for local services, you can add addresses and coordinates throughout a map in the "Publish Settings > Locals" menu inside Fawi Office, so that users can find your application through GPS position on the Fawi Store.
Device
Select device settings.
Notification
Customize how the notifications should looks like setting the icon, sound and color. [All Optional]
NOTE: If you not upload any sepcific notification icon, Fawi will use the App Icon.
Splash Screen
Choose your splashscreen mode that will define your app opening look.
Offline App
Set your app to offline mode [Optional].
NOTE: To provide your offline app you must configure "Fawioffline.js" and upload it to the "https://app_url/root_folder". Learn more
App Orientation
The default orientation of the app [landscape / portrait / any].
Add the links that your App support to Open and Share. [All Optional]
Fawi Version
The current version of Fawi that supports the app.
Devices
Choose the application supported devices.
Hardware Requirements
Describes the minimum requirements to run the app. [Optional]
Permissions
Set the permissions that your App need to use Fawi Native resources. [Optional]
If required, you can't use Fawi Native APIs without setting the App permissions.
Publish
After all your configuration you can publish your app in the store, using "Publish" button from Publish Settings App menu in Fawi Office, and the state will change from Edited to Pendent to be validated by our staff.
If the application fill all requirements it will change the state to Published and it will appear in the store.
If the application doesn't fill all the requirements it will change the status to Rejected and by clicking in the state you can get more information about.
NOTE: App changes can be reverted before publish, returning to the last published app configurations by clicking the Revert Edition button.
You can't publish your application without fill all minimum requirements.
Notifications
Fawi have two ways to send notifications:
- One of them provides you an interface on the "Notifications" from App menu that allows you to send messages to all users;
- The other type allows you to personalize, send messages to topics and create your own notification system using Fawi Notification APIs.
NOTE: With the options you can define your notification contents and preview it before send.
Restricted Users
Invite restricted users to use your app in Restricted Public Mode:
- In the "Restricted Users" from App menu, click on the bottom right button;
- Fill out the form of your new user and click the save button; NOTE: You can change the user profile picture and name anytime.
- Your new user will appear in the "Restricted Users" App menu.
Managers
Invite colaborators to help you manage your Apps:
- In the "Managers" from App menu, click on the bottom right button;
- Fill out the form of your new Manager profile rules and click the save button; NOTE: You can change the manager profile rules anytime.
- Your new manager will appear in the "Managers" App menu.
Deep Link
Open the 'Deep Link' from App menu to download the QR code so users can find the App through the link.
If you want to pass any info to the app you can add that info in the deep link. eg: Without extra info: https://www.hybridstore.com/app/StickMonkey With extra info: https://www.hybridstore.com/app/StickMonkey/customView
To get this extra info the you needs to use the Intent plugin and it's gonna be available inside the "extras" property of the Get() method result object.
Statistics
See the statistics of your application use.
Users
Shows how many users it has.
Views
Indicates how many times the app has been opened.
Favorites
Shows how many users have bookmarked the app.
Shortcuts
How many times the app was added in homescreen.
Rating
Users ratings about the app.
App Lab
A different ambient that simulates the app publication and provides tools for testing the app before publish. Here you have all the Publish Settings options, in exception of the Settings and the Info, to simulate the app publish.
Transfer
The actual app owner can transfer the app to another user sending a transfer invitation. Since the invited user accepts the invitation, he will be the new app owner and the one who has invited will lose all the rigths of the app.
NOTE: The transfer invitation requires the admin user password. You can always cancel the invitation before the invited user accepts.
Delete
Deletes the app. Once you delete an App, you will not be able to get it back.
NOTE: This feature requires the admin user password.
