The master branch is under active development and functionality may change or break at any time!

Installation



Requirements

  • PHP 7.2.0 or higher *
  • mbstring
  • PDO

* Tested on PHP 7.2.x and 7.3.x


Setup

Installing Mako is easy and can be with done in a few simple steps thanks to composer.

First you'll have to create a new project:

composer create-project mako/app <project name>

Next you'll have to make the app/storage/* directories writable (command my vary depending on your system):

chown www-data:www-data -R app/storage

Note that only the most essential services are enabled by default. Enable the ones that you need by uncommenting them in the app/config/application.php configuration file.


Get started

Mako includes a simple development server which can be started with the following command:

php app/reactor server

Open http://localhost:8000 in your browser of choice and you're ready to start coding!

The included development server is great when getting started and for quick prototyping but your should probably use a VM setup that closely resembles your production environment for advanced projects.


Updating

Mako and all your other dependencies can easily be updated when a new release is made available using the following command:

composer update

If you want to bump the Mako version (e.g. from 5.7.* to 6.0.*) then you'll have to update your composer.json file before running the update command.

Some releases might require some minor code changes. These will be documented in the upgrade guides.