https://github.com/cottacush/yii2-base-project

A Yii 2 Base Project Template
https://github.com/cottacush/yii2-base-project

base-project cottacush yii2 yii2-php-framework

Last synced: 3 months ago
JSON representation

A Yii 2 Base Project Template

• Host: GitHub
• URL: https://github.com/cottacush/yii2-base-project
• Owner: CottaCush
• License: mit
• Created: 2016-06-20T13:31:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-03-05T14:30:21.000Z (almost 4 years ago)
• Last Synced: 2024-10-10T22:20:12.003Z (3 months ago)
• Topics: base-project, cottacush, yii2, yii2-php-framework
• Language: PHP
• Homepage:
• Size: 309 KB
• Stars: 5
• Watchers: 10
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
#  Yii2 Base Project

> A Yii 2 Base Project Template

[![Latest Stable Version](https://poser.pugx.org/cottacush/yii2-base-project/v/stable)](https://packagist.org/packages/cottacush/yii2-base-project)

[![Total Downloads](https://poser.pugx.org/cottacush/yii2-base-project/downloads)](https://packagist.org/packages/cottacush/yii2-base-project)

[![License](https://poser.pugx.org/cottacush/yii2-base-project/license)](https://packagist.org/packages/cottacush/yii2-base-project)

**Features**

- [Yii framework](http://www.yiiframework.com/) as the PHP MVC framework.

 

- Security - It sets some headers that projects applications against click-jacking and XSS.

- Assets version - This fixes issue with updates to js and css files and cached browser files.

- New Relic - Ensures that the proper routes show up in the new relic monitoring dashboard.

- Continuous Integration - Sample ant build.xml file that can be easily modified.

## Requirements

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

### Install via Composer

If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).

You can then install this project template using the following command:

~~~

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](http://foundationphp.com/tutorials/apache_vhosts.php)

[Link 2](https://www.kristengrote.com/blog/articles/how-to-set-up-virtual-hosts-using-wamp)

*Mac*

[Link 1](http://coolestguidesontheplanet.com/set-virtual-hosts-apache-mac-osx-10-9-mavericks-osx-10-8-mountain-lion/)

[Link 2](http://coolestguidesontheplanet.com/set-virtual-hosts-apache-mac-osx-10-10-yosemite/)

*Debian Linux*

[Link 1](https://www.digitalocean.com/community/tutorials/how-to-set-up-apache-virtual-hosts-on-ubuntu-14-04-lts)

[Link 2](http://www.unixmen.com/setup-apache-virtual-hosts-on-ubuntu-15-04/)

Sample Virtual Host Config for Apache

```apache

    ServerAdmin [email protected]

    DocumentRoot "/yii2-base-project/app/web"

    ServerName local.yii2-base-template.com

    /yii2-base-project/app/web>

       AllowOverride all

       Options -MultiViews

      Require all granted

    

```

## Build

Dependencies 

- [Ant](http://ant.apache.org/) 

Run build

```

ant

```

## Environment Variables

Make a copy of `.env.sample` to `.env` in the env directory.

## Docker

This project is dockerized using the LEMP stack. The stack consists of:

- PHP 8

- nginx

Inspired by [yii2-dockerized](https://github.com/codemix/yii2-dockerized/blob/master/Dockerfile)

### Installation

[Mac](https://www.docker.com/docker-mac)

[Windows](https://www.docker.com/docker-windows)

[Ubuntu](https://www.docker.com/docker-ubuntu)

### 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](CHANGELOG.md) for more information what has changed recently.

## Security

If you discover any security related issues, please email  instead of using the issue tracker.

## Credits

- Adegoke Obasa 

- [All Contributors](https://github.com/CottaCush/yii2-base-template/graphs/contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.