Skip to content

Latest commit

 

History

History
130 lines (87 loc) · 8.43 KB

README.md

File metadata and controls

130 lines (87 loc) · 8.43 KB
Raw

SoapBerry

builds formaters lints tests

a picture of a soapberry tree in the style of a pixel art

Event-sourced libraries and binary for aggregating, shaping, and journaling, as inspired by the wisdom of maple trees.

What of it

Documentation

tests RedMaple's API Documentation WhirlyBird's API Documentation

Indeed, I am aware of the vibrant and seemingly chaotic appearance of this page, reminiscent of a unicorn's explosion within a candy factory. Please bear with me as I diligently work towards completing the documentation within the allotted time. Rest assured, the colors will gradually transform, becoming less reminiscent of a child's bewildered expression in an art shop left unattended.

  • The Book: Presently, an exquisite online book exists to document the development progress and overarching decisions pertaining to all the projects housed under Soapberry. While the book may appear sparse at the moment, it will progressively flourish with substantial content over time. Currently, it encompasses the following information:

    • Architectural Decision Records (ADRs) that capture crucial decisions made throughout the development process.
    • Insights on how an mdBook can genuinely transform into a visually captivating masterpiece, ensuring an aesthetically pleasing reading experience.

  • API Documentation: Comprehensive API documentations are provided for each crate within their libraries:

Project Structure

Welcome to the enchanting realm of Soapberry, a captivating GitHub repository that brings forth a trio of remarkable crates, each bearing the name of a majestic maple tree analogy. Within this repository, you will discover the boundless potential of event-driven systems, elegantly manifested through the Rust programming language. Together, these masterful creations of Soapberry invite you to embark on a journey of innovation and craftsmanship, crafting resilient and immersive event-driven architectures that resonate with the beauty and wisdom of maple trees

Libraries

crates/redmaple 🌳

redmaple's license Crates.io

At the core of Soapberry lies RedMaple, a versatile and robust crate boasting a generic datatype specifically crafted to hold event aggregates with grace and efficiency.

crates/whirlybird 🍂

whirlybird's license Crates.io

As RedMaple sets the stage, Whirlybird gracefully emerges, presenting a crate adorned with a rich assortment of domain logic tools. Through its wisdom, Whirlybird shapes and molds the events held within RedMaple, empowering developers to navigate the intricate nuances of event processing and transformation.

Applications

crates/kyushu 📔

kyushu's license Crates.io

Completing this exquisite trio is Kyushu, a local-first, event-sourced CLI application that embraces the essence of journalling. With Kyushu, you can effortlessly capture and track events, embracing a seamless and intuitive CLI experience.

Current status

In the realm of Soapberry, I meticulously update project status, while automated badges dynamically reflect its evolving nature.

Development

GitHub commit activity

Engaged in active development, I currently prioritize the project's overarching design. Beyond mere code, I delve into diverse forms, conducting research and experimentation. Embracing a long-term perspective, I refrain from rushing its release. Presently, consider the project to reside in the pre-alpha stage.

Dependencies

up to date no unused dependencies license consistency

Inevitably reliant on libraries, I diligently undertake several measures:

  1. I diligently update them to ensure their optimal functionality.
  2. I meticulously trim down any unused libraries, streamlining the project.
  3. I conscientiously ensure compatibility between my chosen license and the libraries employed.

Security

advisory audit secure dependencies

Imbued with a deep sense of responsibility towards security, I earnestly emphasize its significance. While I may not possess boundless resources to address every CVE within my dependencies, I commit to the following principles:

  1. Meticulously selecting dependencies with a proven track record, ensuring their reliability and robustness.
  2. Transparently acknowledging any potential vulnerabilities present in my dependencies, refusing to conceal them.
  3. Swiftly updating my dependencies upon the release of security updates, prioritizing the safeguarding of the project's integrity.

Contributions

Being the sole contributor to this project at present, my primary objective revolves around stabilizing its fundamental structure. Once accomplished, I eagerly anticipate welcoming Pull Requests from fellow collaborators, accompanied by the inclusion of a CONTRIBUTING.md file. In the meantime, I kindly request adhering to the established code of conduct for all other matters related to the project.