cottacush/phalcon-base-project

Base project for bootstrapping phalcon projects

Phalcon Base Project

![Software License][ico-license] ![Total Downloads][ico-downloads] , _(*1)

Base project for bootstrapping phalcon projects, _(*2)

Requirements

The minimum requirement by this project template that your Web server supports PHP 5.6, _(*3)

• Phalcon 3.0.*
• Composer

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org., _(*4)

You can then install this project template using the following command:, _(*5)

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

Virtual Host Setup

Windows Link 1 Link 2, _(*6)

Mac Link 1 Link 2, _(*7)

Debian Linux Link 1 Link 2, _(*8)

Sample Virtual Host Config for Apache, _(*9)

<VirtualHost *:80>
    ServerAdmin admin@app.com
    DocumentRoot "<WebServer Root Dir>/phalcon-base-project/public"
    ServerName test.phalconbaseproject.com
    ServerAlias test.phalconbaseproject
    SetEnv APPLICATION_ENV test
    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
    </Directory>
</VirtualHost>

Sample Server Block for nginx, _(*10)

server {
    listen      80;
    server_name test.phalconbaseproject.com;
    root        <project root>/public;
    index       index.php;
    charset     utf-8;
    access_log <log directory>/test.phalconbaseproject.com.access.log;
    error_log <log directory>/test.phalconbaseproject.com.error.log;

    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., _(*11)

Install dependencies

composer install, _(*12)

Setting OAuth2 Tables

Create a new database app, _(*13)

Run Migrations by running ./vendor/bin/phinx migrate, _(*14)

Seed the database by running the following commands:, _(*15)

• 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 runtest.sh

Change log

Please see CHANGELOG for more information what has changed recently., _(*16)

Security

If you discover any security related issues, please email developers@cottacush.com instead of using the issue tracker., _(*17)

Credits

• Adeyemi Olaoye yemi@cottacush.com
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*18)