App Template

An empty CakePHP project for use with composer

Requirements

PHP 5.4 and above.

Installation

composer -sdev create-project friendsofcake/app-template ProjectName

This will create a new project, with dependencies, based on this repository. Be sure to point the webserver at the webroot folder and ensure that URL rewriting is configured correctly.

Non-default Configuration

By default, the following has been enabled:

• Composer Autoloading
• Setting Timezone to UTC
• Setting database connection encoding to utf8

You may change either of these at your leisure.

Application Configuration

This template supports - but does not require - configuration of the application via environment variables. This is not required for application configuration - and can be ignored - but is useful on Cloud Platforms and for those requiring extra security around sharing of application secrets and tokens.

To reduce complexity around using the use of this methodology locally, we have also included the josegonzalez/php-dotenv library to load environment variables within your app/Config/core.php. You can create a app/Config/.env file with your configuration and have it autoloaded by the php-dotenv project. A sample app/Config/.env.default has been included for your convenience.

Heroku Compatibility

This application template is compatible with the CHH/heroku-buildpack-php project. To use, simply configure your buildpack:

heroku config:set BUILDPACK_URL=https://github.com/CHH/heroku-buildpack-php
heroku config:set LOG_PATH=/app/vendor/php/var/log/
heroku config:set SECURITY_SALT=SOME_ALPHANUMERIC_SALT_HERE
heroku config:set SECURITY_CIPHER_SEED=SOME_NUMERIC_SEED_HERE

Note about dependencies

FriendsOfCake encourages the use of composer and it's best not to mix composer with git submodules for dependency management. If you need to use submodules you might notice /vendor and /Plugin folders are ignored by git. Composer creates those directories when installing vendors and plugins.

There a few ways to solve this:

• edit the .gitignore file
• use the -f param with git add Plugin/SomePlugin -f
• use app/Plugin and app/Vendor for your submodules.

Included packages

The application template comes with some dependancies already included in the composer file. These are designed to help you get up and running quickly.

• friendsofcake/Crud
• josegonzalez/dotenv
• ad7six/dsn

To find out how to make the most of these packages, please read their respective readme files.