Dev/Mono Repo for MixerAPI — A CakePHP Plugin for RESTful API Development

This is the development repository for MixerAPI. If you are looking to install MixerAPI please visit mixerapi.com or go to MixerApi/MixerApi.

Changes to this repository are automatically pushed to the plugin repositories via Subtree Split.

Install

Clone the project and install composer dependencies for mixerapi-dev and all MixerAPI plugins.

git clone git@github.com:mixerapi/mixerapi-dev.git
composer install

Development

You can require mixerapi/mixerapi-dev in other projects for local development by modifying your composer.json. First, remove mixerapi/mixerapi:

composer remove mixerapi/mixerapi

Next, reference mixerapi/mixerapi-dev using a path repository. The url can be relative or absolute:

    "repositories": [
        {
            "type": "path",
            "url": "../mixerapi-dev",
            "options": {
                "symlink": true
            }
        }
    ]

Then just require mixerapi/mixerapi-dev:

composer require mixerapi/mixerapi-dev @dev

No code changes should be necessary though you may need to run composer dump-autoload.

Unit Tests

Runs unit tests for each plugin.

composer test

Code Standards + Unit Tests

Runs static code analysis and unit tests.

composer analyze

Documentation

See the official documentation at MixerAPI.com.

Documentation was built using MkDocs. It is designed to pull in the README.md files from all MixerAPI plugins. Additional documentation can be added in the docs/ directory and mapped to the navigation in mkdocs.yml.

You can run documentation locally:

composer mkdocs-run

Browse to http://localhost:8000/

To build:

composer mkdocs-build