PragGoLabs / twirpphp

PHP port of Twitch's Twirp RPC framework

Home Page:https://twirphp.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TwirPHP: PHP port of Twitch's Twirp RPC framework

GitHub Workflow Status Twirp Version Go Report Card Composer Package

Installation

Download prebuilt binaries for the protoc plugin from the releases page.

Alternatively, you can use the following oneliner to install the plugin:

curl -Ls https://git.io/twirphp | bash -s -- -b path/to/bin

See the documentation for details.

Documentation

See the official documentation.

Development

Install dependencies:

go mod download
composer install

If you change something in the protoc plugin, regenerate the examples:

make generate

When all coding and testing is done, please run the test suite:

make check

For the best developer experience, install Nix and direnv.

Alternatively, install the following dependencies manually:

  • Go >=1.17
  • PHP 8.x
  • Composer 2.x

Then run make deps to install the remaining dependencies.

Security

If you discover any security related issues, please contact us at twirphp@sagikazarmark.dev.

License

The project is licensed under the MIT License.

The original Twirp library is licensed under the Apache 2.0 License.

About

PHP port of Twitch's Twirp RPC framework

https://twirphp.github.io

License:MIT License


Languages

Language:PHP 67.5%Language:Shell 13.5%Language:Go 12.6%Language:Makefile 4.1%Language:Nix 2.2%