Apps - dfryan/dreamfactory GitHub Wiki

The Apps module allows the developer to further define and update the new application. Use this tab to manage backend app configuration.

Upon application launch in the QuickStart module, the Apps module appears. The Apps module displays all of the users applications in the left-side My Apps list. The Apps module allows the user to preview the application, manage application files, and to delete applications.

NOTE:There are several SDKs that make it easy to make REST API calls to DreamFactory. In Step 2 below, you can choose to download the Javascript SDK. You can also download the SDKs in the API / SDK module, or click on the links below to get the SDKs from GitHub.

• Javascript SDK
• AngularJS SDK
• Android SDK
• iOS SDK

To continue development of your newly launched application:

1. Select and click the app name in the left-side My Apps list.
2. If you want to download a customized Javascript SDK, click the Download JS SDK button.
3. Select where the app will reside by clicking the radio button that corresponds to your choice.
4. Select where you want your app files to be stored.
5. Select a Public name on Launchpad.
6. Enter a Public description on Launchpad.
7. Review and modify the default path, if you want to change the path.
8. Review and select between the Run Full Screen without Toggle and Show Full Screen with Toggle check boxes.
9. Click the Update Application button to save your changes.

Sample Applications

To gain an understanding of how applications work inside of DreamFactory, we have included sample applications. These applications provide a basic overview of the functionality of DreamFactory, and can be deleted at anytime they are no longer needed.

If you would like to import a sample application:

1. Click the Import New App button in the upper right of the screen. The Import App from Package File appears.
2. Select the application from the application list, or click the Browse... button to find a .dfpkg file to import.
3. Finally, click the appropriate Import button.

Additional applications can be found on the DreamFactory GitHub Page.

Local or Remote Application Hosting

Application can use DreamFactory to host all of the application files. Files can be uploaded to the application using the DreamFactory File Manager. Some developers will work on applications using their desktop development tools, and then upload their files to their DreamFactory. The application files can be hosted on either Local File Storage, or Remote File Storage (if the service has been setup in DreamFactory).

Native Device Hosted Application

Native applications use DreamFactory to access the REST system, but all of the application’s files are located on the device or the client.

External Hosted Application

The application can use your DreamFactory to host all of the application files. Files can be uploaded to the application using the DreamFactory File Manager.

If you have an application that is hosted on one of your existing web servers, you can configure your DSP to communicate with this environment by entering the URL of your application.

Preview Applications

Applications can be previewed by clicking the Preview this app (eye) icon next to the application name.

To view the application as a user:

1. Click the Show Apps icon in the upper-right tool bar,
2. Then select the application name from the Default Group that appears.

Application Files

Application files can be stored in the default DreamFactory app storage, or in one of the Remote Files Storage Services. For more information on Remote File Storage, please read our Developer Features Documentation. Files can also be stored on the native device, or a remote client / desktop. If you have an existing application hosted on an external server, you also have the option to supply the URL.

Edit Files in the Browser

When an application is hosted on Local or Remote File Storage, our built-in file editor allows the user to edit the application files in the browser. To edit the file, press the folder icon next to the application. Once you see your files in our file management tool, you can press the pencil icon to the right of the file name.

Delete an Application

Applications can be deleted by pressing the the trash icon. When you delete an application that is hosted on DreamFactory, all of the application files will also be deleted. If the application was using the Local SQL service, any schema will remain on DreamFactory.