ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-19 12:57:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
b2ebe2df0a
devilbox/docs/Examples.md
cytopia b2ebe2df0a
DVL-012 Add documentation for awesome-ci
2017-08-16 09:16:58 +02:00

17 KiB
Raw Blame History

Devilbox Documentation

Overview | Quickstart | Install | Update | Configure | Run | Usage | OS | Backups | Examples | Technical | Hacking | FAQ

Examples

  1. Introduction
    1. Framework/CMS tools
    2. Code analysis tools
  2. Project setup
    1. Setup CakePHP
    2. Setup Drupal
    3. Setup Laravel
    4. Setup Phalcon
    5. Setup Symfony
    6. Setup Wordpress
    7. Setup Yii
    8. Setup Zend
  3. Code analysis
    1. awesome-ci
    2. phpcs
    3. eslint

1. Introduction

The devilbox provides popular tools for setting up and managing major frameworks or content management systems, as well as tools for static code analysis. The following bundled tools are available inside each PHP|HHVM Docker container:

1.1 Framework/CMS tools

You can use the following tools to setup or manage your Frameworks/CMS.

Binary Tool name Framework/CMS
composer composer CakePHPi, Symfony, Yii, Zend and others
drush drush Drupal
drupal drupal-consol Drupal
git git Everything available on github and other git servers
laravel laravel installer Laravel
phalcon phalcon devtools Phalcon
symfony symfony installer Symfony
wp wp-cli Wordpress

1.2 Code analysis tools

You can use the following tools to analyse and fix your source code files.

Binary Tool name Description
file-cr, file-crlf, file-empty, file-nullbyte-char, file-trailing-newline, file-trailing-single-newline, file-trailing-space, file-utf8, file-utf8-bom, git-conflicts, git-ignored, inline-css, inline-js, regex-grep, regex-perl, syntax-bash, syntax-css, syntax-js, syntax-json, syntax-markdown, syntax-perl, syntax-php, syntax-python, syntax-ruby, syntax-scss, syntax-sh awesome-ci General file, code and repository analysis and linting (Some of them also support to fix the problems)
phpcs phpcs Lint and optionally fix your PHP files
eslint eslint Lint and optionally fix your JS files

2. Project Setup

2.1 Setup CakePHP

Official CakePHP Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-cake /shared/httpd/my-cake my_cake loc http://my-cake.loc

It will be ready in eight simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install CakePHP via composer
  4. Symlink webroot directory
  5. Add MySQL database
  6. Configure datbase connection
  7. Setup DNS record
  8. Visit http://my-cake.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-cake

# 3. Install CakePHP via composer
devilbox@php-7.0.20 in /shared/httpd $ cd my-cake
devilbox@php-7.0.20 in /shared/httpd $ composer create-project --prefer-dist cakephp/app cakephp

# 4. Symlink webroot directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s cakephp/webroot/ htdocs

# 5. Add MySQL datbase
devilbox@php-7.0.20 in /shared/httpd $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_cake;'

# 6. Configure datbase connection
devilbox@php-7.0.20 in /shared/httpd $ vi cakephp/config/app.php

<?php
  'Datasources' => [
        'default' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Mysql',
            'persistent' => false,
            'host' => '127.0.0.1',
            /**
             * CakePHP will use the default DB port based on the driver selected
             * MySQL on MAMP uses port 8889, MAMP users will want to uncomment
             * the following line and set the port accordingly
             */
            //'port' => 'non_standard_port_number',
            'username' => 'root',
            'password' => 'secret',
            'database' => 'my_cake',
            'encoding' => 'utf8',
            'timezone' => 'UTC',
            'flags' => [],
            'cacheMetadata' => true,

7. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-cake.loc

8. Open your browser

All set now, you can visit http://my-cake.loc in your browser.

2.2 Setup Drupal

Official Drupal Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-drupal /shared/httpd/my-drupal my_drupal loc http://my-drupal.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Drupal via drush
  4. Symlink Drupal directory
  5. Setup DNS record
  6. Visit http://my-drupal.loc in your browser and follow instructions
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-drupal

# 3. Install Drupal via drush
devilbox@php-7.0.20 in /shared/httpd $ cd my-drupal
devilbox@php-7.0.20 in /shared/httpd $ drush dl drupal

# 4. Symlink Drupal directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s drupal-8.3.3 htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-drupal.loc

6. Open your browser

Open your browser at http://my-drupal.loc and follow the Drupal installation steps.

Note: For MySQL host choose 127.0.0.1.

2.3 Setup Laravel

Official Laravel Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-laravel /shared/httpd/my-laravel - loc http://my-laravel.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Laravel via laravel
  4. Symlink public directory
  5. Setup DNS record
  6. Visit http://my-laravel.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-laravel

# 3. Install Laravel via laravel
devilbox@php-7.0.20 in /shared/httpd $ cd my-laravel
devilbox@php-7.0.20 in /shared/httpd $ laravel new laravel-project

# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s laravel-project/public htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-laravel.loc

6. Open your browser

Open your browser at http://my-laravel.loc

2.4 Setup Phalcon

Official Phalcon Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-phalcon /shared/httpd/my-phalcon - loc http://my-phalcon.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Phalcon via phalcon
  4. Symlink public directory
  5. Setup DNS record
  6. Visit http://my-phalcon.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-phalcon

# 3. Install Phalcon via phalcon
devilbox@php-7.0.20 in /shared/httpd $ cd my-phalcon
devilbox@php-7.0.20 in /shared/httpd $ phalcon project phalconphp

# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s phalconphp/public htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-phalcon.loc

6. Open your browser

Open your browser at http://my-phalcon.loc

2.5 Setup Symfony

Official Symfony Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-symfony /shared/httpd/my-symfony - loc http://my-symfony.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Symfony via symfony
  4. Symlink web directory
  5. Enable Symfony prod (app.php)
  6. Setup DNS record
  7. Visit http://my-symfony.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-symfony

# 3. Install Symfony via symfony
devilbox@php-7.0.20 in /shared/httpd $ cd my-symfony
devilbox@php-7.0.20 in /shared/httpd $ symfony new symfony

# 4. Symlink web directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s symfony/web htdocs

# 5. Enable Symfony production (app.php)
devilbox@php-7.0.20 in /shared/httpd $ cd symfony/web
devilbox@php-7.0.20 in /shared/httpd $ ln -s app.php index.php

6. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-symfony.loc

7. Open your browser

Open your browser at http://my-symfony.loc

2.6 Setup Wordpress

Official Wordpress Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-wp /shared/httpd/my-wp my_wp loc http://my-wp.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Download Wordpress via git
  4. Symlink wordpress git directory
  5. Setup DNS record
  6. Visit http://my-wp.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-wp

# 3. Download Wordpress via git
devilbox@php-7.0.20 in /shared/httpd $ cd my-wp
devilbox@php-7.0.20 in /shared/httpd $ git clone https://github.com/WordPress/WordPress wordpress.git

# 4. Symlink wordpress git directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s wordpress.git htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-wp.loc

6. Open your browser

Open your browser at http://my-wp.loc

2.7 Setup Yii

Official Yii Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-yii /shared/httpd/my-yii - loc http://my-yii.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Yii2 via composer
  4. Symlink web directory
  5. Setup DNS record
  6. Visit http://my-yii.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-yii

# 3. Install Yii2 via composer
devilbox@php-7.0.20 in /shared/httpd $ cd my-yii
devilbox@php-7.0.20 in /shared/httpd $ composer create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic yii2-dev

# 4. Symlink web directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s yii2-dev/web htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-yii.loc

6. Open your browser

Open your browser at http://my-yii.loc

2.8 Setup Zend

Official Zend Documentation

The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Url
my-zend /shared/httpd/my-zend - loc http://my-zend.loc

It will be ready in six simple steps:

  1. Enter the PHP container
  2. Create a new VirtualHost directory
  3. Install Zendframework via composer
  4. Symlink public directory
  5. Setup DNS record
  6. Visit http://my-zend.loc in your browser
# 1. Enter the PHP container
host> ./bash.sh

# 2. Create a new VirtualHost directory
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-zend

# 3. Install Zendframework via composer
devilbox@php-7.0.20 in /shared/httpd $ cd my-zend
devilbox@php-7.0.20 in /shared/httpd $ composer create-project --prefer-dist zendframework/skeleton-application zend

# 4. Symlink public directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s zend/public htdocs

5. DNS record

If you do not have auto-DNS configured, you will need to add the following line to your Host computer's /etc/hosts:

127.0.0.1 my-zend.loc

6. Open your browser

Open your browser at http://my-zend.loc

3. Code analysis

3.1 awesome-ci

awesome-ci is a collection of tools for analysing your workspace and its files. You can for example check for:

  • git conflicts
  • git ignored files that have not been removed from the git index
  • trailing spaces and newlines
  • non-utf8 files or utf8 files with bom
  • windows line feeds
  • null-byte characters
  • empty files
  • syntax errors for various languages
  • inline css or js code
  • customized regex

Some of the bundled tools allow for automatic fixing. See the project page for how to use it: https://github.com/cytopia/awesome-ci.

The following shows an example how to use it with the devilbox:

# 1. Enter your PHP/HHVM container
host> ./bash

# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project

# 3. Run the tools
devilbox@php-7.0.20 $ git-conflicts --path=.
devilbox@php-7.0.20 $ git-ignored --path=.
devilbox@php-7.0.20 $ file-cr --path=.
devilbox@php-7.0.20 $ file-crlf --path=.
devilbox@php-7.0.20 $ file-empty --path=.

# 4. Run tools with more options
devilbox@php-7.0.20 $ syntax-php --path=. --extension=php
devilbox@php-7.0.20 $ syntax-php --path=. --shebang=php
...

3.2 phpcs

phpcs is also available the devilbox:

# 1. Enter your PHP/HHVM container
host> ./bash

# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project

# 3. Run it
devilbox@php-7.0.20 $ phpcs .

For more details visit its project page https://github.com/squizlabs/PHP_CodeSniffer.

3.3 eslint

eslint is also available the devilbox:

# 1. Enter your PHP/HHVM container
host> ./bash

# 2. Go to your project folder
devilbox@php-7.0.20 $ cd /shared/httpd/my-project

# 3. Run it
devilbox@php-7.0.20 $ eslint .

For more details visit its project page http://eslint.org.