Base project for bootstrapping phalcon projects

1.2.0 2017-09-06 14:31 UTC


Latest Version on Packagist Software License Total Downloads CircleCI

Base project for bootstrapping phalcon projects


The minimum requirement by this project template that your Web server supports PHP 5.6

Install via Composer

If you do not have Composer, you may install it by following the instructions at

You can then install this project template using the following command:

composer create-project --prefer-dist cottacush/phalcon-base-project new_project

Virtual Host Setup

Windows Link 1 Link 2

Mac Link 1 Link 2

Debian Linux Link 1 Link 2

Sample Virtual Host Config for Apache

<VirtualHost *:80>
    DocumentRoot "<WebServer Root Dir>/phalcon-base-project/public"
    ServerAlias test.phalconbaseproject
    ErrorLog ${APACHE_LOG_DIR}/test.phalconbaseproject.error.log
    CustomLog ${APACHE_LOG_DIR}/test.phalconbaseproject.access.log common
    <Directory <WebServer Root Dir>/phalcon-base-project/public>
       AllowOverride all
       Options -MultiViews
       Require all granted

Sample Server Block for nginx

server {
    listen      80;
    root        <project root>/public;
    index       index.php;
    charset     utf-8;
    access_log <log directory>/;
    error_log <log directory>/;

    location / {
        try_files $uri $uri/ /index.php?_url=$uri&$args;

    location ~ \.php$ {
        fastcgi_pass unix:<php fpm sock file path>;
        fastcgi_index index.php;
        fastcgi_param APPLICATION_ENV test;
        include <fastcgi params path>/fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root/$fastcgi_script_name;

Environment Variables

Make a copy of .env.sample to .env in the env directory and replace values as appropriate.

Install dependencies

composer install

Setting OAuth2 Tables

Create a new database app

Run Migrations by running ./vendor/bin/phinx migrate

Seed the database by running the following commands:

  • Seed the Oauth Credentials
    CLIENT_ID='<CLIENT_ID>' CLIENT_SECRET='<CLIENT_SECRET>' ./vendor/bin/phinx seed:run -s OauthSeeder -e development

Running Tests

  • Make a copy of .env.sample to .env.test in the env directory and replace values as appropriate.
  • Run the test script

Change log

Please see CHANGELOG for more information what has changed recently.


If you discover any security related issues, please email instead of using the issue tracker.



The MIT License (MIT). Please see License File for more information.