morebec/orkestra

Orkestra is a library of infrastructure and architecture helpers for creating CQRS applications

Maintainers

Details

github.com/Morebec/Orkestra

Source

Issues

Installs: 51

Dependents: 1

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 0

1.0.1 2020-11-05 23:11 UTC

Requires

Requires (Dev)

Proprietary 2f5e51e8b93084dbb0b97215f9ab850e7bc984c8

  • Jwillp <jwilliam.perreault.woop@morebec.com>

This package is auto-updated.

Last update: 2024-03-27 01:02:46 UTC

README

Orkestra is an opinionated framework with a plethora of recommendations on architectural design that we use internally at Morebec to develop new products. It also provides technical tools to quickly create products that are easy to maintain and scale.

At its core, Orkestra provides utilities for DDD, CQRS and Event Sourcing.

Orkestra allows to quickly develop products and applications while maintaining a standardized approach that is easy to understand and improve.

Why Orkestra

Given the current nature of Morebec, which is indie software development, in order to provide value to our clients, we need to be able to have a structure that is similar from project to project, while offering a stable platform that can stand the test of time and scale.

Building applications that will be public facing in production is a challenge in itself that requires a lot of thinking and preparation.

To ensure that we can always provide the same level of quality, while being prepared for the potential scale of our clients, Orkestra serves as both a technical and thinking framework to help us achieve these goals.

From a technical stand point, Orkestra tries to be as unobtrusive as possible by relying mostly on interfaces that denote the conceptual contracts it tries to fulfill. Scalable and resilient CQRS and Event Sourcing requires a lot of plumbing that is very easy to get wrong, as such it provides default implementation of these contracts to stay as much as possible at the edges of the different layers (application, domain and infrastructure.) This set of interfaces allows different projects to extend the framework with their own implementations when needed while still remaining compatible with the Orkestra framework and its ecosystem.

Features

  • Domain Driven Design Building Blocks.
  • Command Query Responsibility Segregation (CQRS) building blocks.
  • Event Sourcing building blocks.
  • Intra Application Messaging.
    • Based on Chain of responsibility pattern (middleware pipeline)
    • Synchronous processing by default.
    • Asynchronous processing using workers and scheduling.
    • Scheduling support.
    • Tracing with correlation and causation tracking.
  • Explicit Personal Information Storage Interface.

Installation

To include Orkestra in your projects, it is highly recommended relying on composer.

Run the following composer command:

$ composer require `morebec/orkestra`

Adapters

Orkestra relies on adapters to add functionality to the base classes.

Usage && Documentation

For the documentation on how to use Orkestra and its core principles, please refer to the docs/ directory.