hmazter/console-skeleton

Skeleton for a console application with DI-container and yaml-config

v0.5.0 2022-08-23 11:38 UTC

This package is auto-updated.

Last update: 2024-10-23 16:39:58 UTC


README

Latest Stable Version Total Downloads License

Skeleton for a console application, including:

Getting started

This will create a new project with the skeleton for a console application:

composer create-project hmazter/console-skeleton the-new-app-name
cd the-new-app-name

The skeleton can then be executed with:

./app

Building distributable phar

A phar-file that can be distributed can be built with:

composer build

This will output the phar-file in the project root, named <project-directory-name>.phar.

Running with docker

Build the app with:

docker-compose build

And run the app with docker with this command:

docker-compose run console ./app

Tests

Tests can be run with:

composer test

Static Code analyse

Code can be static analysed with PHPStan:

composer analyse

Continue building

Go ahead and:

  • Edit/replace command in src/Commad/ExampleCommand
  • Add more commands in src/Command
  • Add additional classed that you need in src/
  • Edit/replace the test in tests/Command/ExampleCommandTest