An open API service indexing awesome lists of open source software.

https://github.com/macagua/example_my_yii2dashboard_demo

A yii2 demo for a web project using cornernote/yii2-dashboard and yii2-workflow
https://github.com/macagua/example_my_yii2dashboard_demo

composer dashboard php yii yii2-application-template yii2-basic yii2-dashboard yii2-extension

Last synced: 3 months ago
JSON representation

A yii2 demo for a web project using cornernote/yii2-dashboard and yii2-workflow

Awesome Lists containing this project

README

        

Yii 2 Basic Project Template
============================

Yii 2 Basic Project Template is a skeleton [Yii 2](http://www.yiiframework.com/) application best for
rapidly creating small projects.

The template contains the basic features including user login/logout and a contact page.
It includes all commonly used configurations that would allow you to focus on adding new
features to your application.

Also includes [yii2-dashboard](https://cornernote.github.io/yii2-dashboard/)
configured with data demo enabled, this is a Yii2 extension for create Dashboard.

The following a screenshot of yii2-dashboard extension:

![Dashboard View](https://cloud.githubusercontent.com/assets/51875/8636670/21febed6-28ae-11e5-8fc7-dc57e5bbc422.png "Dashboard View")

[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2-app-basic/v/stable.png)](https://packagist.org/packages/yiisoft/yii2-app-basic)
[![Total Downloads](https://poser.pugx.org/yiisoft/yii2-app-basic/downloads.png)](https://packagist.org/packages/yiisoft/yii2-app-basic)
[![Build Status](https://travis-ci.org/yiisoft/yii2-app-basic.svg?branch=master)](https://travis-ci.org/yiisoft/yii2-app-basic)

DIRECTORY STRUCTURE
-------------------

assets/ contains assets definition
commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
mail/ contains view files for e-mails
migrations/ contains the migrations script for database
models/ contains model classes
runtime/ contains files generated during runtime
tests/ contains various tests for the basic application
vendor/ contains dependent 3rd-party packages
views/ contains view files for the Web application
web/ contains the entry script and Web resources

REQUIREMENTS
------------

The minimum requirement by this project template that your Web server supports PHP 5.4.0.

INSTALLATION
------------

### Install from an Archive File

Extract the archive file downloaded from [yiiframework.com](http://www.yiiframework.com/download/) to
a directory named `basic` that is directly under the Web root.

Set cookie validation key in `config/web.php` file to some random secret string:

```php
'request' => [
// !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
'cookieValidationKey' => '',
],
```

You can then access the application through the following URL:

~~~
http://localhost/basic/web/
~~~

### Install via Composer

If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions
at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).

You can then install this project template using the following command:

~~~
php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic basic
~~~

Now you should be able to access the application through the following URL, assuming `basic` is the directory
directly under the Web root.

~~~
http://localhost/basic/web/
~~~

CONFIGURATION
-------------

### Database

Edit the file `config/db.php` with real data, for example:

```php
return [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2basic',
'username' => 'root',
'password' => '1234',
'charset' => 'utf8',
];
```

### Enabled Dashboard Module

For Enabled the [Dashboard Module](https://cornernote.github.io/yii2-dashboard/)
configured, please execute the follow command:

```
$ ./yii migrate --migrationPath=@cornernote/dashboard/migrations
```

This way you are created the ``dashboard`` and ``dashboard_panel`` tables used for **Dashboard Module**.

## Running Project migrations

The Project migrations create the initial data the ``dashboard`` and ``dashboard_panel`` tables for use this Webapp,
please execute the follow command:

```
$ ./yii migrate
```

This way you are inserted data for ``dashboard`` and ``dashboard_panel`` tables used for **Dashboard Module**.

**NOTES:**
- Yii won't create the database for you, this has to be done manually before you can access it.
- Check and edit the other files in the `config/` directory to customize your application as required.
- Refer to the README in the `tests` directory for information specific to basic application tests.