catpaw/web-starter

A php CatPaw starter template

4.3.0 2025-01-01 22:51 UTC

Requires

• php: ^8.3
• ext-mbstring: *
• ext-openssl: *
• ext-pcntl: *
• ext-zlib: *
• catpaw/catpaw: ^4.3
• smarty/smarty: ^5.4

Requires (Dev)

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

MIT

• Razvan Tanase

README

First off, configure your project.

make configure

Note

If you don't have Bun installed in your path, this step will install it for you.

Then load your dependencies.

make load

Note

You can run make clean at any time in order to clean created directories, downloaded dependencies and so on.
Running make clean will not uninstall Bun.

Watch Mode

Enter Watch Mode with

make watch

This mode will run the Vite server and your server with XDebug enabled.
Each time your make any change to your server source code, the server will restart automatically.

Note

By default "server source code" means the "src/server" directory.
You can change this configuration in your devkwm file.

Note

See section Debugging with VSCode

Development Mode

Enter Watch Mode with

make dev

This mode will build the Svelte application and run your server with XDebug enabled.
Unlike Watch Mode, your server will not restart when you make changes to your code.
This mode is useful for quick debugging.

Production Mode

Enter Production Mode with

make start

This will build your client bundle and run your server without any debuggers or any other 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/server
• vendor
• statics
• .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.