sidroberts/centum-project

A skeleton project for the Centum framework.

dev-development 2025-08-01 05:18 UTC

This package is auto-updated.

Last update: 2025-08-02 02:06:55 UTC


README

A quick starting point for projects based on the Centum framework.

GitHub release

GitHub issues GitHub pull requests

License

๐Ÿš€ Quick Start

Create a new Centum-based project using Composer:

composer create-project sidroberts/centum-project YOUR-PROJECT-NAME -s dev

cd YOUR-PROJECT-NAME

docker compose up

๐Ÿ“š Documentation

๐Ÿงช Testing

  • Static Analysis: Run Psalm for static code analysis:

    composer analyse
  • Unit & Functional Tests: Run tests with Codeception:

    composer test
  • Code Coverage: Run tests with coverage report:

    composer test-coverage

๐Ÿ—‚๏ธ Project Structure

bin/           # Executables and scripts
config/        # Configuration files
public/        # Public web assets (entry point: index.php)
resources/     # Templates, assets, etc.
src/           # Application source code
tests/         # Test suites
vendor/        # Composer dependencies

๐Ÿ“„ License

Whilst the Centum framework is licensed under the MIT License, this skeleton project is released under the Unlicense license.

See LICENSE.md for more details.