tecnocen/yii2-roa

Yii 2 ROA Library

Yii2 ROA Library

This library contains the modules and controllers to build a ROA application using the Yii2 framework., _(*1)

, _(*2)

Travis , _(*3)

Prerequisites

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

### Installation

Install on a Yii2 App Advanced Project, _(*4)

create new project, _(*5)

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, _(*6)

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:, _(*7)

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

Make sure to create a database to load the migrations, by default the name is yii2_roa_test, _(*8)

Deploy tests

This library includes a composer script to deploy the tests., _(*9)

composer deploy-tests, _(*10)

Run tests

This library also includes 2 composer scripts to run the tests easily., _(*11)

• 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, _(*12)

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., _(*13)

composer yii -- serve [yii2Options], _(*14)

See https://www.yiiframework.com/doc/api/2.0/yii-console-controllers-servecontroller, _(*15)

Then on your browser access the route http://localhost:8080/index.php/api, _(*16)

Other Libraries

You can clone the following repositories and use the live demo they provide, _(*17)

• yii2-formgenerator
• yii2-workflow

Use Cases

TO DO, _(*18)

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., _(*19)

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us., _(*20)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*21)

Considering SemVer for versioning rules 9, 10 and 11 talk about pre-releases, they will not be used within the Tecnocen-com., _(*22)

Authors

• Angel Guevara - Initial work - Tecnocen.com
• Carlos Llamosas - Initial work - Tecnocen.com

See also the list of contributors who participated in this project., _(*23)

License

This project is licensed under the MIT License - see the LICENSE.md file for details, _(*24)

Acknowledgments

• TO DO - Hat tip to anyone who's code was used
• TO DO - Inspiration
• TO DO - etc

, _(*25)