cottacush/yii2-base-project

A Yii 2 Base Project Template

Yii2 Base Project

A Yii 2 Base Project Template, _(*1)

, _(*2)

Features, _(*3)

• Yii framework as the PHP MVC framework., _(*4)

• Security - It sets some headers that projects applications against click-jacking and XSS., _(*5)

• Assets version - This fixes issue with updates to js and css files and cached browser files., _(*6)

• New Relic - Ensures that the proper routes show up in the new relic monitoring dashboard., _(*7)

• Continuous Integration - Sample ant build.xml file that can be easily modified., _(*8)

Requirements

The minimum requirement by this project template that your Web server supports PHP 8.0., _(*9)

Install via Composer

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

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

composer global require "fxp/composer-asset-plugin:~1.4"
composer create-project --prefer-dist cottacush/yii2-base-project new_project

Virtual Host Setup

Windows Link 1 Link 2, _(*12)

Mac Link 1 Link 2, _(*13)

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

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

<VirtualHost *:80>
    ServerAdmin admin@example.com
    DocumentRoot "<WebServer Root Dir>/yii2-base-project/app/web"
    ServerName local.yii2-base-template.com
    <Directory <WebServer Root Dir>/yii2-base-project/app/web>
       AllowOverride all
       Options -MultiViews
      Require all granted
    </Directory>
</VirtualHost>

Build

Dependencies, _(*16)

• Ant

Run build, _(*17)

ant

Environment Variables

Make a copy of .env.sample to .env in the env directory., _(*18)

Docker

This project is dockerized using the LEMP stack. The stack consists of: - PHP 8 - nginx, _(*19)

Inspired by yii2-dockerized, _(*20)

Installation

Mac Windows Ubuntu, _(*21)

Running Containers

• Ensure docker is running
• Change directory to project directory
• Run the command docker-compose up
• To rebuild the containers after updates to docker config files, run docker-compose up --build

Entering Container CLI

• Run the command docker ps
• Check the Container ID for container with image ending with "_web"
• Run the command docker exec -it [container_id] bash

Change log

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

Security

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

Credits

• Adegoke Obasa goke@cottacush.com
• All Contributors

License

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