Quick Start Guide
This guide will have get FML engine running and setup to process user requests from all devices / platforms. We will walk through configuring the backend and then you can test it out using any/all of your favorite platforms. Afterwards you will be able to create your first template using FML on the application frontend.
- Overview
- Download the FML Server
- Configure the Backend for FML
- Run the application
- Conclusion
- Whats next?
A few precursory notes:
If you want to try FML without using a backend server you can download our Offline Desktop Application to use with templates stored locally.
This guide will cover the basics of getting an FML application running from scratch using a pre-compiled version. If you are looking to modify and compile your own version complete that first and then proceed through this guide.
The FML Server is already pre-compiled for simplicity, move the contents to the root directory of the web server.
The server contains the web backend engine and the configuration file used for all of our platforms.
For this guide we are going to do the 2 basic requirements to get a functioning backend for FML applications.
The config.xml is the file that provides all (except offline desktop) application platforms with the initial values they need to run, it must be served from root of address, ex: https://fml.dev/config.xml. Ensure that config.xml has read access then we're going to open and modify the HOME_PAGE value.
When a user first connects to your application the HOME_PAGE is the template file they will be served, you can place the file anywhere within the root and ensure it has read access. Alternatively you can create an api to serve it from a end-point you choose. For fml.dev our home template is called home.xml and it sits under assets/templates, so our configured HOME_PAGE is set to value="assets/templates/home.xml". It must be a relative path from the root of the server (root>assets>templates>home.xml).
We also recommend customizing the APPLICATION_NAME :)
If you want more information about the configuration file click here
Enter the address of your web server, it will run the application in the browser on any device.
You can download the apk from our website here or download our Android application from the Play Store and from the portal you can input the backend server address.
Without compiling the code the only option for iOS devices is to download our iOS application from the App Store and then from the portal you can input the backend server address.
You can download the exe from our website here
You can download the dmg from our website here
Windows Only at the moment, download here
The offline application runs from a template stored on the local system and can exclusively use local templates or a hybrid of offline and templates from a web url.
The config.xml is stored locally within data > flutter_assets > assets and is pre-configured to retrieve the HOME_PAGE from value="file://templates/localtemplate.xml" (assets/templates).
Notice that when referencing local templates within the Offline Desktop Application file:// is prepended onto the url.
You now have everything setup to host and serve FML templates for all platforms. We recommend checking out the links below to learn how to write Flutter Markup Language and build your application's templates.
Important Concepts- Quick Start
- Widget Structure
- Layout Basics
- Config
- Navigation
- Authentication
- Server Configuration
- Offline Use
- Resource Guides
-
<FML/>
- <BOX/>
- <CHART/>
- <COLUMN/>
- <DRAWER/>
- <FOOTER/>
- <FORM/>
- <GRID/>
- <HEADER/>
- <LIST/>
- <MAP/>
- <WINDOW/>
- <PAGER/>
- <ROW/>
- <SCROLLER/>
- <SPLITVIEW/>
- <STACK/>
- <TABLE/>
- <TABVIEW/>
- <TREEVIEW/>
- <WEBVIEW/>