Sample MVC web application that load data from MySQL model to view using Fano Framework
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Fano Web Framework MySql Skeleton Application

Web application skeleton using Fano, Pascal web application framework. This sample application loads data from MySQL database.


Checking for requirement

Make sure Free Pascal is installed. Run

$ fpc -i

If you see something like Free Pascal Compiler version 3.0.4, you are good to go.

Download sample source code

Clone this repository

$ git clone --recursive

--recursive is needed so git also pull Fano repository.

If you are missing --recursive when you clone, you may find that fano directory is empty. In this case run

$ git submodule update --init

To update Fano to its latest commit, run

$ git checkout master && git submodule foreach --recursive git pull origin master

Above command will checkout to master branch of this repository and pull latest update from master branch of Fano repository.

Setup configuration file

Copy *.cfg.sample to *.cfg. Make adjustment as you need in build.cfg,,

These *.cfg files contain some Free Pascal compiler switches that you can turn on/off to change how executable is compiled and generated. For complete explanation on available compiler switches, consult Free Pascal documentation.

Also copy src/config/config.json.sample to src/config/config.json and edit configuration as needed. For example, you may need to change baseUrl to match your own base url so JavaScript or CSS stylesheets point to correct URL.

$ cp src/config/config.json.sample src/config/config.json
$ cp
$ cp
$ cp build.cfg.sample build.cfg

tools/ shell script is provided to simplify copying those configuration files. Following shell command is similar to command above.

$ ./tools/

Setup MySQL database

Before you run application, you need to setup database and table schema. Run tools/ from command line

$ DB_ADMIN=[root user] DB_USER=[user to be created] DB_PASSW=[password] ./tools/

Following command will prompt you to provide password for root and will setup new user with name fano-app-db and password 123456, create database with same name as user, i.e., fano-app-db, and seed all data.

$ DB_ADMIN=root DB_USER=fano-app-db DB_PASSW=123456 ./tools/

After that, you need put new database user credential to src/config/config.json.

Build application

Run shell script (if you are on Windows, build.cmd)

$ ./

By default, it will output binary executable in public directory.

Build for different environment

To build for different environment, set BUILD_TYPE environment variable.

Build for production environment

$ BUILD_TYPE=prod ./

Build process will use compiler configuration defined in vendor/fano/fano.cfg, build.cfg and By default, contains some compiler switches that will aggressively optimize executable both in speed and size.

Build for development environment

$ BUILD_TYPE=dev ./

Build process will use compiler configuration defined in vendor/fano/fano.cfg, build.cfg and

If BUILD_TYPE environment variable is not set, production environment will be assumed.

Change executable output directory

Compilation will output executable to directory defined in EXEC_OUTPUT_DIR environment variable. By default is public directory.

$ EXEC_OUTPUT_DIR=/path/to/public/dir ./

Change executable name

Compilation will use executable filename as defined in EXEC_OUTPUT_NAME environment variable. By default is app.cgi filename.

$ EXEC_OUTPUT_NAME=index.cgi ./


Run with a webserver

Setup a virtual host. Please consult documentation of web server you use.

For example on Apache,

<VirtualHost *:80>
     DocumentRoot /home/example/fano-app-db/public

     <Directory "/home/example/fano-app-db/public">
         Options +ExecCGI
         AllowOverride FileInfo
         Require all granted
         DirectoryIndex app.cgi
         AddHandler cgi-script .cgi

On Apache, you will need to enable CGI module, such as mod_cgi or mod_cgid. If CGI module not loaded, above virtual host will cause app.cgi is downloaded instead of executed.

For example, on Debian, this will enable mod_cgi module.

$ sudo a2enmod cgi
$ sudo systemctl restart apache2

Depending on your server setup, for example, if you use .htaccess, add following code:

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^(.*)$ app.cgi [L]

and put .htaccess file in same directory as app.cgi file (i.e., in app/public directory).

Content of .htaccess basically tells Apache to serve existing files/directories directly. For any non-existing files/directories, pass them to our application.

Simulate run on command line

$ cd app/public
  REQUEST_URI=/test/test \ \

tools/ is bash script that can be used to simplify simulating run application in shell.

$ ./tools/

or to change route to access, set REQUEST_URI variable.

$ REQUEST_URI=/test/test ./

This is similar to simulating browser requesting this page,for example,

$ wget -O- http://[your fano app hostname]/test/test

However, running using tools/ allows you to view output of heaptrc unit for detecting memory leak (if you enable -gh switch in


You need to deploy only executable binary and any supporting files such as HTML templates, images, css stylesheets, application config. Any pas or inc files or shell scripts is not needed in deployment machine in order application to run.

So for this repository, you will need to copy public, Templates, config and storages directories to your deployment machine. make sure that storages directory is writable by web server.

Known Issues

Issue with GNU Linker

When running script, you may encounter following warning:

/usr/bin/ld: warning: public/link.res contains output sections; did you forget -T?

This is known issue between FreePascal and GNU Linker. See FAQ: link.res syntax error, or "did you forget -T?"

However, this warning is minor and can be ignored. It does not affect output executable.

Issue with unsynchronized compiled unit with unit source

Sometime FreePascal can not compile your code because, for example, you deleted a unit source code (.pas) but old generated unit (.ppu, .o, .a files) still there or when you switch between git branches. Solution is to remove those files.

By default, generated compiled units are in bin/unit directory. But do not delete file inside this directory, as it is not being ignored by git.

$ rm bin/unit/*.ppu
$ rm bin/unit/*.o
$ rm bin/unit/*.rsj
$ rm bin/unit/*.a

Following shell command will remove all files inside bin/unit directory except file.

$ find bin/unit ! -name '' -type f -exec rm -f {} +

tools/ script is provided to simplify this task.

Windows user

Free Pascal supports Windows as target operating system, however, this repository is not yet tested on Windows. To target Windows, in build.cfg replace compiler switch -Tlinux with -Twin64 and uncomment line #-WC to become -WC.

Lazarus user

While you can use Lazarus IDE, it is not mandatory tool. Any text editor for code editing (Atom, Visual Studio Code, Sublime, Vim etc) should suffice.