README

This library contains the modules and controllers to build a ROA application using the Yii2 framework.

Scrutinizer

Prerequisites

Install PHP 8.1 or higher
Composer Installed
Run command composer check-platform-reqs to check all requirements.

Installation

Install on a Yii2 App Advanced Project

Create new project

Running the tests

This section is to run the tests on this library, to run the tests on your application check Yii2 App Roa Tests

Configure tests

The tests come preconfigured except for the database credentials, to configure your database credentials create a file tests/_app/config/db.local.php with the Yii2 configuration for Yii::$app->db component. Example:

return [
    'dsn' => ..., 
    'username' => ..., 
    'password' => ..., 
];

Make sure to create a database to load the migrations, by default the name is yii2_roa_test

Deploy tests

This library includes a composer script to deploy the tests.

composer deploy-tests

Run tests

This library also includes 2 composer scripts to run the tests easily.

composer run-tests run all codeception tests.
composer run-coverage run all codeception tests and generate coverage report

Write Tests

You can write new tests on the tests/ folder following codeception documentation

Examples

Yii2 ROA Live Demo

You can run a live demo on a freshly installed project to help you run testing or understand the responses returned by the server.

composer yii -- serve [yii2Options]

See https://www.yiiframework.com/doc/api/2.0/yii-console-controllers-servecontroller

Then on your browser access the route http://localhost:8080/index.php/api

Other Libraries

You can clone the following repositories and use the live demo they provide

Use Cases

TO DO

Built With

Yii 2: The Fast, Secure and Professional PHP Framework http://www.yiiframework.com

Code of Conduct

Please read CODE_OF_CONDUCT.md for details on our code of conduct.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Considering SemVer for versioning rules 9, 10 and 11 talk about pre-releases, they will not be used within the ROAResearch.

Authors

Angel Guevara - Initial work
Carlos Llamosas - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

roaresearch / yii2-roa

Maintainers

Details