Yii API Starter Kit

Yii API Starter Kit is a skeleton application best for rapidly creating API projects.

REQUIREMENTS

• PHP 7.1+
• MongoDB 3.6+

INSTALLATION

Install composer.

Download the archive file and then unpack it.

Copy composer.json.sample to composer.json and update your require data. Then run:

php composer update

CONFIGURATION

Copy /config/secrets.php.sample to /config/secrets.php and put your real data. Copy /config/params.php to /config/params-local.php and update real data.

NOTE:

• DOT NOT edit any files except the composer.json, params-local.php, secrets.php

SETUP

Run all migration scrips:

php yii mongodb-migrate --migrationPath=@vendor/powerkernel/yii-user/src/migrations --migrationCollection=user_migration
php yii mongodb-migrate --migrationPath=@vendor/powerkernel/yii-auth/src/migrations --migrationCollection=auth_migration

Setup the application

php yii setup

NOTE Run the commands in /bin directory

TESTING

Tests are located in tests directory.