gacela-project/gacela

Gacela helps you separate your project into modules

1.7.1 2024-04-16 20:26 UTC

Requires

• php: >=8.1
• gacela-project/container: ^0.6

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• friendsofphp/php-cs-fixer: ^3.53
• infection/infection: ^0.26
• phpbench/phpbench: ^1.2
• phpmetrics/phpmetrics: ^2.8
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.6
• psalm/plugin-phpunit: ^0.18
• rector/rector: ^0.18
• symfony/console: ^5.4
• symfony/var-dumper: ^5.4
• vimeo/psalm: ^5.22

Suggests

• gacela-project/gacela-env-config-reader: Allows to read .env config files
• gacela-project/gacela-yaml-config-reader: Allows to read yml/yaml config files
• gacela-project/phpstan-extension: A set of phpstan rules for Gacela
• symfony/console: Allows to use vendor/bin/gacela script

MIT

• Jose Maria Valera Reales
• Jesus Valera Reales

• framework
• php
• modular
• kernel

README

Gacela helps you build modular applications

VISION: Simplify the communication of your different modules in your web application.

MISSION: Normalize the entry point of a module, without interfering with your domain-business logic.

Splitting your project into different modules help in terms of maintainability and scalability. It encourages your modules to interact with each other in a unified way by following these rules:

• Modules interact with each other only via their Facade
• The Facade is the entry point of a module
• The Factory manage the intra-dependencies the module
• The DependencyProvider resolves the extra-dependencies of the module
• The Config has access to the project's config files

Installation

composer require gacela-project/gacela

Module structure

You can prefix gacela classes with the module name to improve readability. See more about gacela.

An example of an application structure using gacela modules:

application-name
├── gacela.php
├── config
│   └── ...
│
├── src
│   ├── ModuleA
│   │   ├── Domain
│   │   │   └── ...
│   │   ├── Application
│   │   │   └── ...
│   │   ├── Infrastructure
│   │   │   └── ...
│   │   │ # These are the 4 "gacela classes":
│   │   ├── Facade.php
│   │   ├── Factory.php
│   │   ├── DependencyProvider.php
│   │   └── Config.php
│   │
│   └── ModuleB
│       └── ...
│
├── tests
│   └── ...
└── vendor
    └── ...

Documentation

You can check the full documentation in the official website.

Examples

You can see examples using gacela in this repository.

Contribute

You are more than welcome to contribute reporting issues, sharing ideas, or contributing with your Pull Requests.

Inspired by Spryker Framework: https://github.com/spryker