https://github.com/naffiq/yii2-app-bridge
Ready to use yii2-bridge app!
https://github.com/naffiq/yii2-app-bridge
Last synced: about 2 months ago
JSON representation
Ready to use yii2-bridge app!
- Host: GitHub
- URL: https://github.com/naffiq/yii2-app-bridge
- Owner: naffiq
- License: other
- Created: 2018-01-02T08:25:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-23T08:41:32.000Z (about 7 years ago)
- Last Synced: 2025-01-26T03:23:40.698Z (4 months ago)
- Language: PHP
- Size: 2.44 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii 2 Bridge App
Based on «Yii 2 Basic Project Template» and is a skeleton [Yii 2](http://www.yiiframework.com/) application best for
rapidly creating small projects with admin panel.
## Installation
Create project via composer by running following command:
```bash
$ 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.
```bash
$ 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:
```bash
$ ./vendor/bin/bridge-install
```
## Usage
With fresh installation you will have [http://localhost:8008/admin/](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](https://github.com/naffiq/yii2-bridge/wiki) (in progress)
## Users
Yii2 Bridge utilizes [yii2-usuario](https://github.com/2amigos/yii2-usuario) under the hood, which takes user management to new level. Create your first user with CLI command:
```bash
$ php yii user/create // role should be admin for your first user
```
Read [Usuario docs](http://yii2-usuario.readthedocs.io/en/latest/) 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`:
```php
prod
```
> Note: `mode.php` is registered in `.gitignore` to prevent config collisions between environments. You have to create it manually or with [deployer](https://deployer.org) job once in every project environment.
Refer to [janisto/yii2-environment](https://github.com/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:
```bash
$ ./vendor/bin/codecept
```