spreling/yii2-template

Yii 2 Spreling Project Template

1.0 2015-08-25 12:34 UTC

Requires

• php: >=5.4.0
• himiklab/yii2-recaptcha-widget: 1.0.4
• romdim/yii2-bootstrap-material: 1.0
• yiisoft/yii2: >=2.0.6
• yiisoft/yii2-bootstrap: *
• yiisoft/yii2-swiftmailer: *

Requires (Dev)

• yiisoft/yii2-debug: *
• yiisoft/yii2-gii: *

BSD-3-Clause

• Harm Jacob Drijfhout

• framework
• yii2
• project template
• Spreling

README

This is a skeleton Yii 2 application best for developing complex Web applications with mutiple tiers. It is derriven form the Yii 2 Advanced Project Template.

The template includes three tiers: front end, back end, and console, each of which is a separate Yii application

The template is designed to work in a team development environment. It supports deploying the application in different environments.

In additon to the Yii 2 Advanced Project Template there is a restructure of the Directory Structure. This Template build arround the idea of Modules and all the components even the core ones are wrapt in modules. Through this it becomes easy to deploy a collection of pre build modules in this skeleton to quick build a website.

Documentation is at the wiki.

DIRECTORY STRUCTURE

_common
    engine/
        config/          contains shared configurations
        modules/         contains all the modules used in both backend and frontend    
          core/          contains the core files for this skeleton used in both backend and frontend  
           models/       contains model classes used in both backend and frontend
    vendor/              contains dependent 3rd-party packages
_environments            contains environment-based overrides
_init                    contains script for environment-based overrides and a requirements check script
backend
    engine/
        config/          contains backend configurations
        modules/         contains all the modules used in the frontend    
          core/          contains the core files for this skeleton used in the frontend
            components/  contains Web component classes
            controllers/ contains Web controller classes
            models/      contains backend-specific model classes
            views/       contains view files for the Web application
            widgets/     contains frontend widgets
    web/                 contains the entry script and Web resources 
      assets/            contains application assets such as JavaScript and CSS
      css/               contains css that is not generated by the application
      resources/         contains all the resource needed for the website except CSS and Javascript
    runtime/             contains files generated during runtime
console
    engine/
        config/          contains console configurations
        modules/         contains all the modules used in the console    
          core/          contains the core files for this skeleton used in console
            controllers/ contains console controllers (commands)
            models/      contains console-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains various tests for the advanced application
frontend
    engine/
        config/          contains frontend configurations
        modules/         contains all the modules used in the frontend    
          core/          contains the core files for this skeleton used in the frontend
            components/  contains Web component classes
            controllers/ contains Web controller classes
            models/      contains frontend-specific model classes
            views/       contains view files for the Web application
            widgets/     contains frontend widgets
    web/                 contains the entry script and Web resources 
      assets/            contains application assets such as JavaScript and CSS
      css/               contains css that is not generated by the application
      resources/         contains all the resource needed for the website except CSS and Javascript
    runtime/             contains files generated during runtime