Example projects

The following example projects can be downloaded. They contain build files and have instructions of how to run.


The Quickstart sample is described in Introduction to Actors and walks you through example code that introduces how to define actor systems, actors, and messages.


This project contains a Dining Hakkers sample illustrating how to model a Finite State Machine (FSM) with actors.


This project contains samples illustrating different Cluster features, such as subscribing to cluster membership events, and sending messages to actors running on nodes in the cluster with Cluster aware routers.

It also includes Multi JVM Testing with the sbt-multi-jvm plugin.

Distributed Data

This project contains several samples illustrating how to use Distributed Data.

Cluster Sharding

This project contains a KillrWeather sample illustrating how to use Cluster Sharding.

Persistence and CQRS

The Microservices with Akka tutorial contains a Shopping Cart sample illustrating how to use Event Sourcing and Projections together. The events are consumed by even processors to build other representations from the events, or publish the events to other services.

Replicated Event Sourcing

The Akka Distributed Cluster Guide illustrates how to use Replicated Event Sourcing that supports active-active persistent entities across data centers.

Kafka to Cluster Sharding

This project demonstrates how to use the External Shard Allocation strategy to co-locate the consumption of Kafka partitions with the shard that processes the messages.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.