mirrors/frankenphp
1
0
Fork 0
mirror of https://github.com/dunglas/frankenphp synced 2024-10-16 09:08:22 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
291b9464bc
frankenphp/CONTRIBUTING.md
Kévin Dunglas 291b9464bc
docs: improve contribution guide
2022-10-15 18:42:24 +02:00

2.0 KiB
Raw Blame History

Contributing

Running the test suite

go test -race -v ./...

Debugging

With Docker (Linux)

Build the dev Docker image:

docker build -t frankenphp-dev Dockerfile.dev 
docker run -p 8080:8080 -p 443:443 -v $PWD:/go/src/app -it frankenphp-dev bash

The image contains the usual development tools (Go, GDB, Valgrind, Neovim...).

Caddy module

Build Caddy with the FrankenPHP Caddy module:

cd /go/src/app/caddy/frankenphp/
go build

Run the Caddy with the FrankenPHP Caddy module:

cd /go/src/app/testdata/
../caddy/frankenphp/frankenphp run

Minimal test server

Build the minimal test server:

cd /go/src/app/internal/testserver/
go build

Run the test server:

cd /go/src/app/testdata/
../internal/testserver/testserver

The server is listening on 127.0.0.1:8080:

curl http://127.0.0.1:8080/phpinfo.php

Without Docker (Linux and macOS)

Compile PHP:

./configure --enable-debug --enable-zts
make -j6
sudo make install

Build the minimal test server:

cd internal/testserver/
go build

Run the test app:

cd ../../testdata/
../internal/testserver/testserver

Misc Dev Resources