QR Code generator web application

QR Code generator web application using Fano Framework, Pascal web application framework

This project is generated using Fano CLI command line tools to help scaffolding web application using Fano Framework.

Requirement

• Free Pascal >= 3.0
• Web Server (Apache 2.4, nginx)
• mod_proxy_scgi if using Apache
• git
• Fano Web Framework
• QRCodeGenLib4Pascal

Installation

TLDR

Make sure that Free Pascal compiler is installed.

$ git clone git@github.com:zamronypj/qrme.git --recursive
$ ./tools/config.setup.sh
$ ./build.sh
$ mkdir storages
$ mkdir storages/logs
$ mkdir storages/sessions

If you have Fano CLI installed, run

$ sudo fanocli --deploy-scgi=qrme.fano

Command above will setup virtual host for Apache using mod_proxy_scgi. If you have nginx, add --web-server=nginx

$ sudo fanocli --deploy-scgi=qrme.fano --web-server=nginx

Please read Deploy as SCGI application Fano Framework documentation for more information.

If you do not have Fano CLI installed, you need to setup virtual host manually as shown in Run with a Web Server section of this document.

After you setup virtual host, run application binary

$ ./bin/app.cgi

Open Internet browser and go to URL http://qrme.fano/qrcode/svg or http://qrme.fano/qrcode/png to generate QR Code with SVG or PNG format respectively.

Both URL accept query string parameters to customize QR Code,

• ud to set value to encode in QR Code, for example, ud=hello%20world.
• fg to set foreground color, for example, fg=%23ff0000 to set color to red.
• bg to set background color, for example, bg=%230000f0 to set color to purple.
• sc to set scale, for example, sc=12.
• bd to set border, for example, bd=2.

Free Pascal installation

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.

Clone this repository

$ git clone git@github.com:zamronypj/qrme.git --recursive

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

If you are missing --recursive when you clone, you may find that vendor/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.

Copy *.cfg.sample to *.cfg. Make adjustment as you need in build.cfg, build.prod.cfg, build.dev.cfg and run build.sh shell script (if you are on Windows, then build.cmd).

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 config/config.json.sample config/config.json
$ cp build.prod.cfg.sample build.prod.cfg
$ cp build.dev.cfg.sample build.dev.cfg
$ cp build.cfg.sample build.cfg
$ ./build.sh

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

$ ./tools/config.setup.sh
$ ./build.sh

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.sh

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

Build for development environment

$ BUILD_TYPE=dev ./build.sh

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

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 bin directory.

$ EXEC_OUTPUT_DIR=/path/to/bin/dir ./build.sh

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 ./build.sh

Run

Run with a webserver

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

For example on Apache,

<VirtualHost *:80>

    ServerAdmin admin@qrme.fano
    DocumentRoot "/path/to/repo/directory/public"

    ServerName qrme.fano
    ServerAlias *.qrme.fano

    ErrorLog /var/log/apache2/qrme.fano-error.log
    CustomLog /var/log/apache2/qrme.fano-access.log combined

    <Directory "/home/zamroni/fun/qrme/QrMe/public">
        Options -MultiViews -FollowSymlinks +SymlinksIfOwnerMatch +ExecCGI
        AllowOverride FileInfo Indexes
        Require all granted
    </Directory>

    ProxyRequests Off
    ProxyPassMatch "/css|js|images|img|plugins|bower_components(.*)" !
    ProxyPassMatch ^/(.*)$ "scgi://127.0.0.1:20477"
</VirtualHost>

On Apache, you will need to enable SCGI module, mod_proxy and mod_proxy_scgi. In Apache 2.4, this modules is already installed and enabled. If not, then run

$ sudo a2enmod proxy_scgi
$ sudo systemctl restart apache2

Deployment

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 build.sh 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 Free Pascal 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 Free Pascal 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 README.md 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 README.md file.

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

tools/clean.sh 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.