mynameiszanders/yiiskeleton

Yii skeleton app for quick bootstrapping of new projects via Composer's create-project command.

New Project

This project is designed to kickstart/bootstrap a new Yii application through Composer commands. Although it doesn't provide any functionality other than basic user authentication, it does provide many event declarations and an Event/Behaviour manager to allow the building of drop-in addons., _(*1)

This project utilises the following libraries:, _(*2)

• PHPass: a library for the easy and secure management of passwords in PHP.
• Yii Framework: a high-performance PHP framework best for developing Web 2.0 applications.

License

This project is licensed under the MIT/X11 open-source license. Copyright is held by the projects author, Zander Baldwin (2013)., _(*3)

Documentation

Documentation is somewhat lacking for this project. Efforts have been focused on developing the application shell. Documentation will start appearing once this project reaches beta status., _(*4)

All current documentation for this project is within the source-code itself, as comments or DocComments., _(*5)

Source Code

This project is kept under Git and is hosted on the GitHub. Source code can be accessed from git@github.com:mynameiszanders/yiiskeleton.git., _(*6)

Installation

This project is designed to be installed via Composer's create-project command., _(*7)

composer create-project mynameiszanders/yiiskeleton /path/to/project 1.0.0-alpha

Create the file application/config/databases.php which returns an array of environment-separated database credentials. For example:, _(*8)

<?php
    return array(
        'develop' => array(
            'connectionString' => 'mysql:host=localhost;dbname=test',
            'username' => 'root',
            'password' => '',
        ),
        'production' => array(
            'connectionString' => 'mysql:host=localhost;dbname=longDatabaseName',
            'username' => 'accountName',
            'password' => 'supersecret',
            'tablePrefix' => 'app_'
        ),
    );

Next, place the name of your chosen environment inside application/config/.environment. Then perform the database migration which will upgrade your database to work with the application:, _(*9)

PROJECT="/path/to/project"

$ cd "$PROJECT/application"
$ ./yiic migrate

Note: This project has been built on the presumption that it will run on a 64-bit Debian, or Ubuntu, server with PHP 5.3+., _(*10)

Authors

• Zander Baldwin; project lead.

Contact

Please contact Darsyn directly on the following details for bug reports, feature requests, patch submissions, etc.:, _(*11)

Development Guidelines

Database

After you have set up your database credentials in application.config.databases, all changes to the database that are not done through normal application operations must be done through database migrations with the yiic tool. This means any schema changes, and default data., _(*12)

As a rule of thumb, until you are comfortable with database changes being done this way, the use of phpMyAdmin is forbidden except as a reference tool., _(*13)

Source Code

Coming soon..., _(*14)