twirp
PHP port of Twitch's Twirp RPC framework
File Explorer
Download Latest Version (.zip)- .gitattributes
- .gitignore
- generate.go
- go.mod
- go.sum
- lint.go
- main.go
- tests.go
- tests_e2e.go
- versions.go
- versions_pinned.go
- bug_report.yaml
- config.yml
- feature_request.yaml
- artifacts.yaml
- ci-depot.yaml
- ci.yaml
- release.yaml
- static.yaml
- .editorconfig
- dependabot.yaml
- PULL_REQUEST_TEMPLATE.md
- SECURITY.md
- SUPPORT.md
- custom.css
- highlight.css
- http-headers.rst
- other-services.rst
- psr15.rst
- best-practices.rst
- installation.rst
- overview.rst
- usage.rst
- .gitignore
- conf.py
- index.rst
- make.bat
- Makefile
- requirements.txt
- spelling_word_list.txt
- Haberdasher.php
- .gitignore
- client.php
- README.md
- server.php
- service.proto
- BaseServerHooks.php
- CanEmitJsonDefaults.php
- ChainServerHooks.php
- Context.php
- Error.php
- ErrorCode.php
- Router.php
- Server.php
- ServerHooks.php
- ServerWithPathPrefix.php
- BaseServerHooksTest.php
- ChainServerHooksTest.php
- ContextTest.php
- ErrorCodeTest.php
- RouterTest.php
- ServerTest.php
- generator.go
- template.go
- func.go
- comment.go
- name.go
- global.go
- TwirpError.php.tmpl
- _Service_.php.tmpl
- AbstractClient.php.tmpl
- Client.php.tmpl
- JsonClient.php.tmpl
- Server.php.tmpl
- service.go
- main.go
- logo-dark.png
- logo.png
- clientcompat.proto
- compat.php
- compat.sh
- run.sh
- Haberdasher.php
- HaberdasherFunctionalTest.php
- HaberdasherJsonClientTest.php
- HaberdasherServerTest.php
- Psr15HttpClient.php
- ServerHooksErrorStub.php
- TwirpErrorTest.php
- phpunit.xml.dist
- run.sh
- service.proto
- run.sh
- service.proto
- test.php
- run.sh
- service.proto
- .gitignore
- .dockerignore
- .editorconfig
- .envrc
- .gitattributes
- .gitignore
- .golangci.yaml
- .goreleaser.yaml
- .php-cs-fixer.dist.php
- .yamllint.yaml
- ADOPTERS.md
- CHANGELOG.md
- composer.json
- dagger.json
- flake.lock
- flake.nix
- go.mod
- go.sum
- install.sh
- LICENSE
- LICENSE_THIRD_PARTY
- Makefile
- phpstan-baseline.neon
- phpstan.neon.dist
- phpunit.xml.dist
- psalm.xml
- README.md
- TWIRP_VERSION
# Installation Guide
1. Get the code
git clone https://github.com/twirphp/twirp
Downloads the entire project code from GitHub to your computer.
cd twirp
Moves into the project folder you just downloaded.
2. PHP (Composer)
Easy RecommendedPrerequisites
composer install
Installs the PHP libraries listed in composer.json.
Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.
Pulled directly from this repo's README.
3. Go
MediumPrerequisites
cd .dagger
This project's files live in a subfolder, so move into it first.
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make generate
Compiles the code based on the generated build configuration to produce an executable.
make check
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)