https://github.com/mixerapi/mixerapi-dev

Development (monorepo) repository for MixerAPI
https://github.com/mixerapi/mixerapi-dev

Last synced: about 1 month ago
JSON representation

Development (monorepo) repository for MixerAPI

• Host: GitHub
• URL: https://github.com/mixerapi/mixerapi-dev
• Owner: mixerapi
• License: mit
• Created: 2020-12-12T14:23:52.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T23:50:11.000Z (9 months ago)
• Last Synced: 2024-04-23T13:58:26.920Z (8 months ago)
• Language: PHP
• Homepage: https://mixerapi.com
• Size: 979 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Logo](./assets/mixerapi.svg#gh-light-mode-only)



    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](https://mixerapi.com/) or go to [MixerApi/MixerApi](https://github.com/mixerapi/mixerapi).

Changes to this repository are automatically pushed to the plugin repositories via

[Subtree Split](https://www.subtreesplit.com/).

## Install

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

```console

git clone [email protected]: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:

```console

composer remove mixerapi/mixerapi

```

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

```json

    "repositories": [

        {

            "type": "path",

            "url": "../mixerapi-dev",

            "options": {

                "symlink": true

            }

        }

    ]

```

Then just require mixerapi/mixerapi-dev:

```console

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.

```console

composer test

```

### Code Standards + Unit Tests

Runs static code analysis and unit tests.

```console

composer analyze

```

## Documentation

See the official documentation at [MixerAPI.com](https://mixerapi.com).

Documentation was built using [MkDocs](https://squidfunk.github.io/mkdocs-material/). 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:

```console

composer mkdocs-run

```

_Browse to http://localhost:8000/_

To build:

```console

composer mkdocs-build

```