cottacush/phalcon-base-project

Base project for bootstrapping phalcon projects

1.2.0 2017-09-06 14:31 UTC

Requires

• ext-phalcon: >=3.0.0
• bshaffer/oauth2-server-php: ^1.8
• cottacush/phalcon-utils: ^2.2
• phalcon/incubator: ^3.0
• redound/phalcon-rest: ^1.4.0
• robmorgan/phinx: ^0.5.3
• vlucas/phpdotenv: ^2.2

Requires (Dev)

• codeception/codeception: ^2.2
• flow/jsonpath: ^0.3.1
• league/fractal: ^0.13.0
• pagerfanta/pagerfanta: ^1.0
• pdepend/pdepend: 2.2.4
• phploc/phploc: *
• phpmd/phpmd: @stable
• redcomponent/teststatistics: ^2.2
• sebastian/phpcpd: *
• squizlabs/php_codesniffer: 2.*

Suggests

• besimple/soap-client: Install SOAP Client for connecting with SOAP services
• league/fractal: Install Fractal to use Transformers
• mcustiel/phiremock-codeception-extension: Install phiremock for mocking
• pagerfanta/pagerfanta: Install PagerFanta to use Pagination
• wsdl2phpgenerator/wsdl2phpgenerator: Install WSDL2PHP generator to generate classes from WSDL
• xamin/handlebars.php: Install Handlebars for fluent templating

MIT

• Adeyemi Olaoye

• framework
• basic
• phalcon
• project template
• improved

README

Base project for bootstrapping phalcon projects

Requirements

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

• Phalcon 3.0.*
• Composer

Install via Composer

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

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>
    ServerAdmin [e-mail]
    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

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.

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

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• [Adeyemi Olaoye [e-mail]] link-author
• All Contributors

License

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