https://github.com/dominus77/yii2-advanced-start
Yii2 Start Project Advanced Template
https://github.com/dominus77/yii2-advanced-start
advanced dominus77 yii2 yii2-advanced-start yii2-start
Last synced: 2 months ago
JSON representation
Yii2 Start Project Advanced Template
- Host: GitHub
- URL: https://github.com/dominus77/yii2-advanced-start
- Owner: Dominus77
- License: mit
- Created: 2016-10-23T11:27:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T17:54:17.000Z (7 months ago)
- Last Synced: 2025-03-24T09:39:48.743Z (3 months ago)
- Topics: advanced, dominus77, yii2, yii2-advanced-start, yii2-start
- Language: PHP
- Homepage: https://dominus77.github.io/yii2-advanced-start/
- Size: 5.64 MB
- Stars: 23
- Watchers: 8
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Yii2 Start Project Advanced Template
[](https://packagist.org/packages/dominus77/yii2-advanced-start)
[](https://github.com/Dominus77/yii2-advanced-start/blob/master/LICENSE.md)
[](https://github.com/Dominus77/yii2-advanced-start/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/Dominus77/yii2-advanced-start/?branch=master)
[](https://scrutinizer-ci.com/code-intelligence)
[](https://packagist.org/packages/dominus77/yii2-advanced-start)
The application is built using advanced pattern and has a modular structure.
Backend part uses [AdminLTE](https://adminlte.io/) template
Available console user management commands and RBAC system.
## Base components
Pages (backend AdminLTE template)
- Home
- Users
- RBAC
- Profile
- Login
- [Maintenance](https://github.com/Dominus77/yii2-maintenance)
Pages (frontend)
- Home
- Contact
- Sign Up
- Profile
- Login
- [Maintenance](https://github.com/Dominus77/yii2-maintenance)
Modules
- main
- rbac
- users
Functional
- Reset password
- Confirmation by email
- Last visit
- RBAC Management from the console and web interface
- [Maintenance](https://github.com/Dominus77/yii2-maintenance)
System
- RBAC (DbManager)
- Manage users
- [Manage maintenance](https://github.com/Dominus77/yii2-maintenance)
- Console commands
- i18n
## CSS Themes Bootstrap
The template includes the of the CSS Theme Bootstrap
Switching the theme occurs in the `/frontend/config/main.php`
## Requirements
The minimum requirement by this project template that your Web server supports PHP 5.6.0.
## Directory Structure
```plaintext
api
components/ contains components api application
config/ contains api application configurations
messages/ contains i18n api application
modules/ contains modules api version application
runtime/ contains files generated during runtime
tests/ contains tests for api application
web/ contains the entry script
common
assets/ contains application assets such as JavaScript and CSS
components/ contains components frontend, backend and console
config/ contains shared configurations
mail/ contains layouts files for e-mails
messages/ contains i18n backend frontend
models/ contains model classes used in both backend and frontend
tests/ contains tests for common classes
widgets/ contains widgets backend and frontend
console
components/ contains console components
config/ contains console configurations
controllers/ contains console controllers (commands)
messages/ contains i18n console
migrations/ contains database migrations
models/ contains console-specific model classes
runtime/ contains files generated during runtime
backend
assets/ contains application assets such as JavaScript and CSS
components/ contains backend components
config/ contains backend configurations
controllers/ contains Web controller classes
messages/ contains i18n backend
models/ contains backend-specific model classes
runtime/ contains files generated during runtime
tests/ contains tests for backend application
views/ contains view files for the Web application
web/ contains the entry script and Web resources
widgets/ contains backend widgets
frontend
assets/ contains application assets such as JavaScript and CSS
config/ contains frontend configurations
controllers/ contains Web controller classes
messages/ contains i18n frontend
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
modules/
main/ contains module main
controllers/ contains module Web controller classes
backend/ contains module backend Web controller classes
frontend/ contains module frontend Web controller classes
messages/ contains i18n module
models/ contains module-specific model classes
backend/ contains module backend-specific model classes
frontend/ contains module frontend-specific model classes
traits/ contains module traits
views/ contains module view files for the Web application
backend/ contains module backend view files for the Web application
frontend/ contains module frontend view files for the Web application
Bootstrap.php File autoload module settings app components (urlManager)
Module.php General Module class
rbac/ contains module rbac
components/ rules and rbac init
behavior/ access backend behavior
console/ contains console controllers (commands)
controllers/ contains module Web controller classes
backend/ contains module backend Web controller classes
messages/ contains i18n module
migrations/ contains database migrations module
models/ contains module-specific model classes
tests/ contains module tests
traits/ contains module traits
views/ contains module view files for the Web application
backend/ contains module backend view files for the Web application
Bootstrap.php File autoload module settings app components (urlManager)
Module.php General Module class
users/ contains module users
behavior/ contains module behavior
commands/ contains console controllers (commands)
controllers/ contains module Web controller classes
backend/ contains module backend Web controller classes
frontend/ contains module frontend Web controller classes
mail/ contains module view files for e-mails
messages/ contains i18n module
migrations/ contains database migrations module
models/ contains module-specific model classes
backend/ contains module backend-specific model classes
frontend/ contains module frontend-specific model classes
traits/ contains module traits
views/ contains module view files for the Web application
ajax/ contains module ajax.js
backend/ contains module backend view files for the Web application
frontend/ contains module frontend view files for the Web application
widgets/ contains module widgets
Bootstrap.php File autoload module settings app components (urlManager)
Module.php General Module class
```
## Installation
The preferred way to install this project is through [composer](http://getcomposer.org/download/).
Create a project:
```bash
composer create-project --prefer-dist --stability=dev dominus77/yii2-advanced-start public_html
```
or clone the repository for `pull` command availability:
```bash
git clone https://github.com/Dominus77/yii2-advanced-start.git public_html
cd public_html
composer install
```
Init an environment:
Run command in the root directory `public_html` of the project
if Development environment
```
composer app-init-dev
```
if Production environment
```
composer app-init-prod
```
otherwise choose Wednesday
```
php init
```
### Yii Application Requirement Checker
See `http://sitename.com/requirements.php`
> Note: For production environment it is recommended to delete the `frontend\web\requirements.php` file
If everything is in order, move on, otherwise configure the server configuration.
## Continue
Create a database, default configure yii2_advanced_start in `common\config\main-local.php`
```php
$config = [
//...
'components' => [
'db' => [
'dsn' => 'mysql:host=localhost;dbname=yii2_advanced_start',
//...
],
//...
],
//...
];
```
Apply migration:
```bash
composer migrate-up
```
Initialization RBAC:
```bash
composer rbac-init
```
Create user, enter the command and follow the instructions:
```bash
php yii users/user/create
```
- Username: set username (admin);
- Email: set email (`[email protected]`);
- Password: set password (min 6 symbol);
- Status: set status (0 - blocked, 1 - active, 2 - wait, ? - Help);
Assign role admin:
```bash
php yii rbac/roles/assign
```
- Username: set username (admin);
- Role: set role (admin, editor, manager, super_admin, user, ? - Help); (This set configure rbac module models Role.php, Permission.php and in folder components to RbacInit.php)
If you are installing the server into the public_html folder on the server with Apache, you must configure redirection.
At the root folder, create a public_html .hitaccess with the following content:
```apache
Options FollowSymLinks
AddDefaultCharset utf-8
RewriteEngine On
# the main rewrite rule for the frontend application
RewriteCond %{REQUEST_URI} !^/(backend/web|admin)
RewriteCond %{REQUEST_URI} !^/(api/web|api)
RewriteRule !^frontend/web /frontend/web%{REQUEST_URI} [L]
# redirect to the page without a trailing slash (uncomment if necessary)
#RewriteCond %{REQUEST_URI} ^/admin/$
#RewriteRule ^(admin)/ /$1 [L,R=301]
# the main rewrite rule for the backend application
RewriteCond %{REQUEST_URI} ^/admin
RewriteRule ^admin(.*) /backend/web/$1 [L]
# redirect to the page without a trailing slash (uncomment if necessary)
#RewriteCond %{REQUEST_URI} ^/api/$
#RewriteRule ^(api)/ /$1 [L,R=301]
# the main rewrite rule for the api application
RewriteCond %{REQUEST_URI} ^/api
RewriteRule ^api(.*) /api/web/$1 [L]
# if a directory or a file of the frontend application exists, use the request directly
RewriteCond %{REQUEST_URI} ^/frontend/web
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# otherwise forward the request to index.php
RewriteRule . /frontend/web/index.php [L]
# if a directory or a file of the backend application exists, use the request directly
RewriteCond %{REQUEST_URI} ^/backend/web
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# otherwise forward the request to index.php
RewriteRule . /backend/web/index.php [L]
# if a directory or a file of the api application exists, use the request directly
RewriteCond %{REQUEST_URI} ^/api/web
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# otherwise forward the request to index.php
RewriteRule . /api/web/index.php [L]
RewriteCond %{REQUEST_URI} \.(htaccess|htpasswd|svn|git)
RewriteRule \.(htaccess|htpasswd|svn|git) - [F]
```
The web folder, the backend, frontend and api parts also add .hitaccess:
```apache
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . index.php
```
Now frontend is available at `http://sitename.com`, and backend at `http://sitename.com/admin`, and api `http://sitename.com/api/v1/users`
## Code Sniffer
```bash
composer check-style
```
## Testing
Create a database, default configure yii2_advanced_start_test in `common\config\test-local.php`
```php
$config = [
//...
'components' => [
'db' => [
'dsn' => 'mysql:host=localhost;dbname=yii2_advanced_start_test',
//...
],
//...
],
//...
];
```
Apply migration:
```bash
composer migrate-test-up
```
#### Run in console
```bash
composer build
composer test
```
## License
The BSD License (BSD). Please see [License File](https://github.com/Dominus77/yii2-advanced-start/blob/master/LICENSE.md) for more information.