Documentation Formio v1.0.0 - Documentation v1.0

Documentation

This documentation will explain the details of Formio, the installation process, files, usage and settings.

a. Getting Started

Formio is not based on a framework thus you can install it nearly every PHP web server or shared hosting but here is our recommended specifications;

  • PHP >= 7.0
  • MySQL & PDO
  • JSON & Mail Extensions*
*Mail extension is not obligatory, we are using an external SMTP Mail Library, but it would be good.

b. Installation

Formio comes with a prebuilt installation wizard. After creating a MySQL database you can easily install it by following steps.

b1. Creating Database

Before installing, you will need to create a new database. If you already know how to do this or have already created one, skip to the next step. Probably you should be able to create a database from cPanel.

You can use these official documents if you do not know how to do it:

b2. Uploading Files

After creating a database, unzip the .zip file you have downloaded from CodeCanyon and upload files inside Server Files to your main directory (usually called www or public_html) or a sub-directory.

After upload process has done, open yourdomain.com/installer.php.

WARNING  Note that you should use a desktop app like FileZilla to upload your files to you server via FTP instead of web-based file managers to avoid corruption on your files.

b3. Installation Wizard

After you have created a database and uploaded the files, simply open your website in a web browser and follow on-screen instructions on the installation wizard to complete the installation.


c. Configuration

c1. General Settings

You can set up site and mail settings from here. You can go there by visiting General > Settings page.


c2. User Settings

You can set up you user settings from here and also you can create new accouts. Each accounts have same permissions in system. You can go there by visiting User > User Settings page.


d. Usage

d1. Creating New Form

You can create new forms by visiting Form Management > Create a New Form page.

  • Form Status  Determine that your form is accepting new responses or not.
  • Form Response Type  Select what is going to happen after a visitor submits form.
  • Form Response URL  Enter the URL that you want to redirect the visitor after form submission, only works with URL Redirect.
  • Response Email  Enter the email that you want to get responses of the form. Works with all Form Types except Save on Formio.


d2. Getting Responses

You need to set up your forms action url as yourdomain.com/form-api/[form-special-id].

You can get your form's special ID from the form edit page like shown in the image below: