bytehunter/yii2-standard

Yii2 template focused on serving RESTful API, with some cool extra features

v1.0.1 2017-02-16 17:18 UTC

Requires

• php: >=5.4.0
• dmstr/yii2-adminlte-asset: 2.*
• yiisoft/yii2: ~2.0.6
• yiisoft/yii2-bootstrap: ~2.0.0
• yiisoft/yii2-shell: ^2.0
• yiisoft/yii2-swiftmailer: ~2.0.0

Requires (Dev)

• codeception/base: ^2.2.3
• codeception/verify: ~0.3.1
• yiisoft/yii2-debug: ~2.0.0
• yiisoft/yii2-faker: ~2.0.0
• yiisoft/yii2-gii: ~2.0.0

BSD-3-Clause

• framework
• restful
• application template
• yii2
• bytehunter

README

This is a variation of Yii 2 Advanced Project Template, which is focused on deployment of RESTful API services.

This template has four tiers: frontend, panel (administration frontend), console and api.

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

DIRECTORY STRUCTURE

api
    common/              contains common
    config/              contains api configurations
    modules/             contains api versions separated by modules
        v1/              contains a major api version
            controllers/ contains version specific api controllers
            models/      contains version specific api models
    runtime/             contains files generated during runtime
    web/                 contains the entry script
common
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in both backend and frontend
    tests/               contains tests for common classes    
console
    config/              contains console configurations
    controllers/         contains console controllers (commands)
    migrations/          contains database migrations
    models/              contains console-specific model classes
    runtime/             contains files generated during runtime
panel
    assets/              contains application assets such as JavaScript and CSS
    config/              contains panel configurations
    controllers/         contains Web controller classes
    models/              contains panel-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for panel application    
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
frontend
    assets/              contains application assets such as JavaScript and CSS
    config/              contains frontend configurations
    controllers/         contains Web controller classes
    models/              contains frontend-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for frontend application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
    widgets/             contains frontend widgets
vendor/                  contains dependent 3rd-party packages
environments/            contains environment-based overrides