Ecosyste.ms: Awesome

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

https://github.com/samdark/yii2-minimal

Yii 2 minimal application template
https://github.com/samdark/yii2-minimal

minimal project-template yii2

Last synced: about 2 months ago
JSON representation

Yii 2 minimal application template

Lists

README

        

Yii 2 Minimal Application Template
================================

Yii 2 Minimal Application Template is a skeleton Yii 2 application best for
starting totally from scratch.

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

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

commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
models/ contains model classes
runtime/ contains files generated during runtime
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 application template that your Web server supports PHP 5.4.0.

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

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 application template using the following command:

~~~
composer create-project --prefer-dist --stability=dev samdark/yii2-minimal path/to/your/project
~~~

Now you should be able to access the application through the following URL, assuming your server webroot is pointed to
`project/web` directory.

~~~
http://localhost/
~~~

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

### Database

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

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

**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.