https://github.com/twirphp/twirp

PHP port of Twitch's Twirp RPC framework
https://github.com/twirphp/twirp

code-generator hactoberfest php protobuf protocol-buffers rpc twirp

Last synced: 2 months ago
JSON representation

PHP port of Twitch's Twirp RPC framework

• Host: GitHub
• URL: https://github.com/twirphp/twirp
• Owner: twirphp
• License: mit
• Created: 2018-03-31T08:54:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-18T22:04:51.000Z (4 months ago)
• Last Synced: 2024-09-19T01:11:54.918Z (4 months ago)
• Topics: code-generator, hactoberfest, php, protobuf, protocol-buffers, rpc, twirp
• Language: PHP
• Homepage: https://twirphp.github.io
• Size: 755 KB
• Stars: 153
• Watchers: 7
• Forks: 19
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: .github/SECURITY.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• php-awesome - Twirp - Twirp PHP 版本 (类库 / PRC)

README

        


  

    

      

      

    

  

  


    TwirPHP

  


[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/twirphp/twirp/ci.yaml?style=flat-square)](https://github.com/twirphp/twirp/actions/workflows/ci.yaml)

[![Twirp Version](http://img.shields.io/badge/twirp%20version-v7-orange.svg?style=flat-square)](https://twitchtv.github.io/twirp/docs/spec_v7.html)

[![Go Report Card](https://goreportcard.com/badge/github.com/twirphp/twirp?style=flat-square)](https://goreportcard.com/report/github.com/twirphp/twirp)

[![Composer Package](http://img.shields.io/badge/composer-twirp%2Ftwirp-green.svg?style=flat-square)](https://packagist.org/packages/twirp/twirp)

**PHP port of Twitch's [Twirp](https://twitchtv.github.io/twirp/) RPC framework**

## Installation

Download prebuilt binaries for the protoc plugin from the [releases](https://github.com/twirphp/twirp/releases) page.

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

```bash

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

```

See the [documentation](https://twirphp.github.io/docs/installation) for details.

## Documentation

See the [official documentation](https://twirphp.github.io/).

## Development

**For an optimal developer experience, it is recommended to install [Nix](https://nixos.org/download.html) and [direnv](https://direnv.net/docs/installation.html).**

_Alternatively, install [Go](https://go.dev/dl/), [PHP](https://www.php.net/) and [Composer](https://getcomposer.org/download/) on your computer then run `make deps` to install the rest of the dependencies._

Install dependencies:

```shell

go mod download

composer install

```

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

```shell

make generate

```

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

```shell

make check

```

## Security

If you discover any security related issues, please contact us at [[email protected]](mailto:[email protected]).

## License

The project is licensed under the [MIT License](LICENSE).

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