catpaw/starter

A php CatPaw starter template

4.3.0 2025-01-01 22:50 UTC

Requires

• php: ^8.2
• ext-mbstring: *
• ext-openssl: *
• ext-pcntl: *
• ext-zlib: *
• catpaw/catpaw: ^4.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9

MIT

• Razvan Tanase

README

You can run your program in one of three modes.

Development Mode

Enter Development Mode with

make dev

This mode will run your program with XDebug enabled.

Note

See section Debugging with VSCode

Watch Mode

Enter Watch Mode with

make watch

This mode will run your program with XDebug enabled and it will restart your program every time you make a change to your source code.

Note

See section Debugging with VSCode

Note

By default "source code" means the "src" directory.
You can change this configuration in your makefile, see section watch, parameter resources.

Production Mode

Enter Production Mode with

make start

It's just as it sounds, run your program directly.
No debuggers, not extra overhead.

Build

It is possible, but no required, to bundle your program into a single .phar file with

make build

The building process can be configured inside the build.ini file.

After building your application, you can simply run it using

php out/app.phar

The resulting .phar will include the following directories

• src
• vendor
• .build-cache (created at build time)

It's a portable bundle, you just need to make sure php is installed on whatever machine you're trying to run it on.

Debugging with VSCode

Install xdebug

apt install php8.3-xdebug

Configure your .vscode/launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen",
            "type": "php",
            "request": "launch",
            "port": 9003
        }
    ]
}

Start debugging.