REST API application template
Clone or download
machour and hiqsol Fixing travis build (#5)
* Enabled travis

* Fix package id and travis tld
Latest commit 0e298a6 Dec 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config minimize api Nov 19, 2018
runtime first step init repo Nov 19, 2018
src first step init repo Nov 19, 2018
tests Fixing travis build (#5) Dec 27, 2018
.gitignore Fixing travis build (#5) Dec 27, 2018
.travis.yml Fixing travis build (#5) Dec 27, 2018
LICENSE.md first step init repo Nov 19, 2018
README.md Fixing travis build (#5) Dec 27, 2018
composer.json Fixing travis build (#5) Dec 27, 2018
composer.lock Fixing travis build (#5) Dec 27, 2018
phpunit.xml.dist Fixing travis build (#5) Dec 27, 2018
requirements.php first step init repo Nov 19, 2018

README.md

Yii Framework

Yii Framework REST API Application


This package is Yii Framework REST API application best for rapidly creating projects.

The template includes all commonly used configurations that would allow you to focus on adding new features to your application.

Latest Stable Version Total Downloads Build Status

DIRECTORY STRUCTURE

bin/
config/             contains application configurations
public/             contains the entry script for a web server
runtime/            contains files generated during runtime
src/
  assets/             contains assets definition
  commands/           contains console commands (controllers)
  controllers/        contains Web controller classes
  mail/               contains view files for e-mails
  models/             contains model classes
  views/              contains view files for the Web application
tests/              contains various tests for the basic application
vendor/             contains dependent 3rd-party packages
.env
.env.dist
composer.json

REQUIREMENTS

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

INSTALLATION

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

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

composer create-project --prefer-dist --stability=dev yiisoft/app myapp
cd myapp
./vendor/bin/yii serve

Now you should be able to access the application via http://localhost:8080/.

CONFIGURATION

Database

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

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

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.

TESTING

Tests are located in tests directory.