Fun.CQRS is a Scala CQRS/ES framework. It provides the basic blocks to build event driven aggregates with Event Sourcing.
Scala
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs/src/main
modules
project
samples/raffle/src
.gitignore
.scalafmt.conf
.travis.yml
LICENSE
README.md
build.sbt
jvmopts.travis
microsites.sbt
migration-v1.0.0.md
pubring.gpg.enc
repositories.sbt
roadmap-v1.0.0.md
secring.gpg.enc
sonatype.sbt
version.sbt

README.md

Fun.CQRS

Build Status

Fun.CQRS is a Scala library for building CQRS/ES application. It provides the basic blocks to build event driven aggregates with Event Sourcing.

Fun.CQRS provides a out-of-the-box AkkaBackend and a InMemoryBackend for testing. However, it's designed as such that other backend implementations are possible. For instance, an alternative Akka backend based on Eventuate, a Slick backend or RxScala backend could be implementated and plugged in easily.

When using the AkkaBackend, Aggregates are immutable classes (case class) that live inside an Actor. You don't have to deal much with Akka and it's powerful abstractions, instead you concentrate in modeling your aggregate behavior and its protocol (Commands and Events). However you still need a minimal understanding of how Akka works and how to configure Akka Persistence to use your persistence plugin of choice.

That said, in Fun.CQRS, Aggregates are NOT Actors. The Actor System is used as a middleware to manage the aggregates, hold them in-memory, store events, recover aggregate state and generate read models through Event Projections

Migration Guide to v1.0.0

As we progress with the v1.0.0 we update the migration guide.

Please, make sure you follow all the instructions and broadly test your migrated project before using it with production data.

Project artifact

The artifacts are published to Sonatype Repository. Simply add the following to your build.sbt.

libraryDependencies += "org.funcqrs" %% "fun-cqrs-akka" % "1.0.1"

If you want to hack Fun.CQRS and develop your own backend, you can import only the core module. The core module does NOT include the Akka Backend.

libraryDependencies += "org.funcqrs" %% "fun-cqrs-core" % "1.0.1"

Documentation

There is a sample application under fun-cqrs/samples/raffle (up-to-date).

You can also watch these two videos to better understand the philosophy behind Fun.CQRS.

Devoxx 2015 (2h45m)
Scala Exchange 2015 (45m)
Note that this two presentations contains code that have been refactored in the mean time. However, you will get a good picture of the available features by watching the videos.

Contribution policy

Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please state that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.