This short document will show you how to get the code working. For a more detailed explanation and documentation visit the article series at ParticleBits (@todo).

Navigate to app/etc/env and update the config files. To get started you only need to update the local.php file. Feel free to add/remove/rename any file in this directory. The config files in here are environment specific and extend the config settings in app/etc/config.php. You'll probably need to update the paths and MySQL config at a minimum. Make sure the paths->hostname is without the http://.

Open a terminal, navigate to the deploy directory, and run:

./install.sh <profile>

where <profile> is the name of the config file for the current environment (local, development, production, etc.). This will copy the environment config file to app/etc/config.local.php.

In the same terminal and directory, run:

./update_sql_db.sh <mysql arguments>

to run the SQL statements. For example:

./update_sql_db.sh -u root -ppassword -h localhost

You can also copy and execute the SQL commands in deploy/sql/ manually. Run ./update_sql_db.sh -h for help info about the script.

Point your browser to the base path you specified in the config. You should see the welcome message and info page.