hiqdev/hisite-template

HiSite Project Template

dev-master 2018-07-08 11:43 UTC

README

HiSite Project Template

Latest Stable Version Total Downloads Build Status Scrutinizer Code Coverage Scrutinizer Code Quality Dependency Status

HiSite is a base project for building modular Yii2 web applications from plugins.

This package is a template to start your HiSite project with.

It includes:

Live Demo

Installation

Preferred way to install this project is through composer:

composer create-project --stability=dev "hiqdev/hisite-template:*" dir

HiSite uses hidev to automate repetitive tasks:

  • create and chmod standard files and directories needed to run application:
    • web/index.php, src/config/bootstrap.php
    • web/assets/, runtime/
  • generate and keep up to date package files: README, LICENSE, .gitignore, composer.json
  • keep CHANGELOG file with chkipper
  • run standard tasks such as running tests and php-cs-fixer
  • substitute yii console script

To finish project installation run:

./vendor/bin/hidev deploy

You will see:

Created dir:  ./web/
Created dir:  ./web/assets/
chmod ./web/assets '0777'
Written file: ./web/index.php
Written file: ./web/robots.txt
Copied file: ./web/favicon.ico
chmod ./runtime '0777'
Written file: ./src/config/bootstrap.php

And that's it — the project is ready to be served with web server. But hidev can do a bit more for you.

Generate and install NGINX vhost config

Copy .env.example to .env and tune it to set project wide options:

  • ENV - environment env/prod, will be used to setup YII_ENV constant
  • SSL - enable SSL, used for NGINX config
  • HOSTS - hostname(s), used for NGINX config

To see generated NGINX config without actually installing it use the following command:

./vendor/bin/hidev nginx/dump

To install config and restart NGINX run:

./vendor/bin/hidev nginx/deploy

License

This project is released under the terms of the BSD-3-Clause license. Read more here.

Copyright © 2016-2017, HiQDev (http://hiqdev.com/)