Installation

Folder structure

After extracting the zipped file you will get the following files:

1. public_html.zip contains the laravel project. Move this file to your web root folder (e.g. public_html in cPanel or httpdocs in Plesk.) and then extract it.
2. frontend-src.zip contains source code for the views used in the applications. The frontend is already bundled in the laravel project, this folder is shipped if you have development experience and you want to customize the frontend code.
3. help.txt contains basic instructions to extract files.

Prerequisites

Mandatory requirements

The server must have the following software installed:

1. PHP >= v8.2
2. MySQL or MariaDB.
3. PHP Imagick extension.
4. PHP GD library.
5. PHP BCMath extension.
6. allow_url_fopen to be enabled.

Optional requirements

1. Inkscape
2. exec and shell_exec functions enabled.

Note

Inkscape and exec function are only used to render languages with complex layout like Arabic and Urdu, if you do not plan to support such languages, the mandatory requirements are enough.

If you have the above software installed on the remote machine you can continue further to the application installer.

Installation steps

1. Upload public_html.zip file to your webroot and then extract it.

   cPanel webroot folder is public_html.

   Plesk webroot folder is httpdocs.

2. Create a database and corresponding user on your remote server.

   For cPanel shared hosting please refer to: How To Create or Delete a MySQL Database or User

3. SMTP credentials to send transactional emails (Optional).

   If you plan to use an email account on cPanel hosting to send transactional emails, please consult: Setting Up and Troubleshooting SMTP in cPanel

   For VPS you may use transactional email services, a service like brevo offer 300 daily transactional emails for free.

   If you plan to use the application for personal uses, you may not need the SMTP credentials and you can skip the SMTP step in the installation wizard.