Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codefyphp/codefy
A PHP framework for codefying and building complex applications using Domain-Driven Design, CQRS, and Event Sourcing.
https://github.com/codefyphp/codefy
cqrs cqrs-es domain-driven-design domain-driven-development domain-driven-framework event-sourcing hacktoberfest
Last synced: 2 months ago
JSON representation
A PHP framework for codefying and building complex applications using Domain-Driven Design, CQRS, and Event Sourcing.
- Host: GitHub
- URL: https://github.com/codefyphp/codefy
- Owner: codefyphp
- License: mit
- Created: 2022-09-15T01:41:05.000Z (almost 2 years ago)
- Default Branch: 1.x
- Last Pushed: 2023-11-19T03:07:27.000Z (8 months ago)
- Last Synced: 2024-02-02T08:04:07.598Z (5 months ago)
- Topics: cqrs, cqrs-es, domain-driven-design, domain-driven-development, domain-driven-framework, event-sourcing, hacktoberfest
- Language: PHP
- Homepage: https://codefyphp.com/
- Size: 189 KB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Lists
- awesome-ddd - CodefyPHP Framework - A PHP framework for codefying and building complex applications using Domain-Driven Design, CQRS, and Event Sourcing. (Sample Projects / PHP)
README
---
CodefyPHP is __not__ a framework such as the likes of Symfony, Laravel, Codeigniter or CakePHP. Codefy is a simple,
light framework providing interfaces and implementations for architecting a Domain Driven project with
CQRS, Event Sourcing and implementations of [PSR-3](https://www.php-fig.org/psr/psr-3),
[PSR-6](https://www.php-fig.org/psr/psr-6), [PSR-7](https://www.php-fig.org/psr/psr-7),
[PSR-11](https://www.php-fig.org/psr/psr-11), [PSR-12](https://www.php-fig.org/psr/psr-12/),
[PSR-15](https://www.php-fig.org/psr/psr-15), [PSR-16](https://www.php-fig.org/psr/psr-16)
and [PSR-17](https://www.php-fig.org/psr/psr-17).
The philosophy of Codefy is that code should be systematized, maintainable, and follow OOP (Object-Oriented Programming).
CodefyPHP tries not to be too opinionated, yet encourages best practices and coding standards by following [Qubus Coding
Standards](https://github.com/QubusPHP/qubus-coding-standard). Use Codefy as you see fit. You can tap into all, some or
none of the features and instead use the interfaces to build your own implementations for a domain driven project.
## 📍 Requirement
- PHP 8.2+
- Additional constraints based on which components are used.
## 🏆 Highlighted Features
- A powerful [routing engine](https://docs.qubusphp.com/routing/)
- Robust [dependency injector](https://docs.qubusphp.com/dependency-injector/) for bootstrapping
- Adapters for cookies, sessions and cache storage
- Provides a simple hook and event system without affecting core code
- Encourages object-oriented programming
- Multiple PSR implementations
- Dual query builders with migrations
- Scheduler for scheduling tasks/jobs
- Security and sanitizing helpers
- Dual templating engines
## 📦 Installation
You can use the composer command below to install the library, or by creating a new Codefy project using the
[skeleton](https://github.com/CodefyPHP/skeleton) package.
```bash
composer require codefyphp/codefy
```
## 🕑 Releases
| Version | Minimum PHP Version | Release Date | Bug Fixes Until | Security Fixes Until |
|---------|---------------------|----------------|-----------------|----------------------|
| 1 | 8.2 | September 2023 | July 2024 | March 2025 |
| 2 - LTS | 8.2 | January 2024 | January 2027 | January 2028 |
| 3 | 8.3 | January 2024 | November 2024 | July 2025 |
| 4 - LTS | 8.3 | May 2024 | May 2027 | May 2028 |
## 📘 Documentation
Documentation is still a work in progress. Between the [Qubus Components](https://docs.qubusphp.com/) documentation
and [CodefyPHP's](https://codefyphp.com/documentation/) documentation, that should help you get started. If you have questions or
need help, feel free to ask for help in the [forums](https://codefyphp.com/community/).
## 🙌 Sponsors
If you use CodefyPHP or you are interested in supporting the continued development of my opensource projects,
please consider sponsoring me via [Github](https://github.com/sponsors/parkerj) or [Ko-fi](https://ko-fi.com/nomadicjosh).
## 🖋 Contributing
CodefyPHP could always be better! If you are interested in contributing enhancements or bug fixes, here are a few
rules to follow in order to ease code reviews, and discussions before I accept and merge your work.
- You MUST follow the [QubusPHP Coding Standards](https://github.com/QubusPHP/qubus-coding-standard).
- You MUST write (or update) unit tests.
- You SHOULD write documentation.
- Please, write [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
and rebase your branch before submitting your Pull Request.
- Please [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too.
This is used to "clean" your Pull Request before merging it (I don't want commits such as `fix tests`, `fix 2`, `fix 3`,
etc.).
## 🔐 Security Vulnerabilities
If you discover a vulnerability in the code, please email [[email protected]](mailto:[email protected]).
## 📄 License
CodefyPHP is opensource software licensed under the [MIT License](https://opensource.org/license/MIT/).