naffiq/yii2-app-bridge

Yii 2 Bridge Project Template

v0.2.3 2018-04-23 08:40 UTC

Requires

• php: >=5.4.0
• janisto/yii2-environment: ^1.3
• naffiq/yii2-bridge: ~0.9.0
• yiisoft/yii2: ~2.0.5
• yiisoft/yii2-bootstrap: ~2.0.0
• yiisoft/yii2-swiftmailer: ~2.0.0

Requires (Dev)

• codeception/base: ^2.2.3
• codeception/specify: ~0.4.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
• Bridge
• yii2
• project template

README

Yii 2 Bridge App

Based on «Yii 2 Basic Project Template» and is a skeleton Yii 2 application best for rapidly creating small projects with admin panel.

Installation

Create project via composer by running following command:

$ composer create-project naffiq/yii2-app-bridge MY_APP_NAME

Create config/local.php (you may copy config/example.local.php for example) and configure your local environment DB.

$ cp config/example.local.php config/local.php

Note: local.php is registered in .gitignore to prevent config collisions between developers

Then run migrations with single command:

$ ./vendor/bin/bridge-install

Usage

With fresh installation you will have http://localhost:8008/admin/ (assuming you run php yii serve) which is yii2-bridge. Add your sub-modules for creating admin sections. More docs at Yii2 Bridge Wiki (in progress)

Users

Yii2 Bridge utilizes yii2-usuario under the hood, which takes user management to new level. Create your first user with CLI command:

$ php yii user/create <email> <username> <password> <role> // role should be admin for your first user

Read Usuario docs for further details.

Environment

You can pre-configure application for different environments and switch them easily. Change your config for different modes in these files:

• config/local.php — Local development. This file overwrites all configuration defined in your main.php or mode_*.php files;
• config/mode_stage.php — Staging (development) server;
• config/mode_prod.php — Production server;
• config/mode_test.php — Configuration for tests (used by codeception);

Then switch easily between them by creating mode.php file with mode name:

Example of config/mode.php:

prod

Note: mode.php is registered in .gitignore to prevent config collisions between environments. You have to create it manually or with deployer job once in every project environment.

Refer to janisto/yii2-environment for further details.

Testing

The app is ready to test and has example test for 2amigos/yii2-usuario user model with fixture included. Run tests with:

$ ./vendor/bin/codecept