Build and Deployment

Build and Deployment

This article should give overall overview of how to deploy CUK system. What are its specifics and what should be avoided or what is recommended. Given to web-nature of the system, there is no such thing as build and only deployment will be discussed.

Deployment

Deployment should be done on machine which is equipped with PHP 7.0 or higher with some HTTP web server, preferably Apache. For the database layer it is recommended to use MySQL, but CUK should be able to work with any well-known database server (thanks to Doctrine).

CUK is designed to run only on secured web-servers which engage HTTPS protocol. Consider it during development and further deployment. HTTP protocol is not supported and there may be needed further modifications to make it work.

If you have only FTP access to the remote web-server all following work has to be done on localhost and then transfered to the remote server, with a little extra work concerning database. Description of installation steps follows.

Installation

@todo: further desc

• Clone the git repository
• Run composer install
• Create a database and fill in the access information in app/config/config.local.neon (for an example, see app/config/config.local.example.neon)
• Setup the database schema by running php index.php orm:schema-tool:update --force
• Fill database with initial values by running php index.php db:fill

Do not forget to make directories temp/ and log/ writable.

It is critical that whole app/, log/ and temp/ directories are not accessible directly via a web browser. See security warning for further details.

Startup

@todo: apache

@todo: nginx, do not forget to make directories not accessible

@todo: built-in webserver... but supports only http... not usable

Deployment in non-CZ country

CUK was developed in the Czech Republic and for the needs of IFMSA CZ. If you want to deploy CUK in the other country you have to take care of some czech texts mostly in the content of web pages. Translations are not yet provided by default in CUK and might be implemented in the future releases.

Development

CUK system is written with major help of Nette 2.3 framework. So if you want to contribute to this project, at least basic knowledge of Nette framework is needed. Further description of architecture of whole project can be found in Architecture article. Any meaningfull contributions will be considered and eventually merged, so do not hesitate to reimplement nasty parts or add new features.

CUK is developed under MIT License thus it can be forked, modified or commercialize without any further restrictions.