Yii2 Enhanced

Table of Contents

1. Purpose
2. Description
3. Technologies used
4. Code conventions
5. Directory structure
6. Installation

Purpose

The purpose of this project is to provide an advanced Yii2 template.

Description

Yii2 enhanced provides an easily set uppable and configurable Yii2 environment with Vagrant, with a preconfigured dev server for forntend and backend.

Technologies used

• Vagrant

  • Used for setting up the development environment

• Yii2

  • Robust PHP framework
  • Guide
  • The project uses Yii2 advanced template

• PostgreSQL 11

Code conventions

• MVC software design pattern
• The project uses the PSR-12 coding standard for PHP

Directory structure

project
|   LICENSE.md
|   README.md
|   Vagrantfile         // Used for an easy development environment setup
└───backend
|   └─── controllers
|   └─── models
|   └───views
|   └───web
└───common
|   └───config          // Database configuration here
|   └───models          // Contains all database models
└───console
|   └───controllers
|   └───dummy-data      // Use for an easy database test data fillup
|   └───migrations      // Contains all necessary migrations
└───frontend
|   └───controllers
|   └───models
|   └───views
|   └───web
└───vagrant
|   └───config          // Contains the vagrant configurations files
|   └───provision

Installation

1. Install VirtualBox
2. Install Vagrant
3. Create a GitHub personal API token
4. Clone repository:

  git clone https://github.com/grabovszky/yii2-enhanced.git

5. Configure vagrant-local.yml with your GitHub API token:

  cd /path/to/application/vagrant/config
  cp vagrant-local.example.yml vagrant-local.yml

6. Execute init and select development environment:

  cd cd /path/to/yii-application/
  ./init

8. Install vagrant plugins and run vagrant

  cd /path/to/yii-application/
  vagrant plugin install vagrant-hostmanager
  vagrant plugin install vagrant-vbguest
  vagrant up

9. You are all set, you can view your application at ticketing-system.test