Samples

New to Akka? Start here:

Author your first Akka service to get a minimal "Hello World!" Akka service and run it locally.

Samples are available that demonstrate important patterns and abstractions. These can be downloaded as zip files. Please refer to the README file in each zip for setup and usage instructions.

Description Source download Level

Build a shopping cart

shopping-cart-quickstart.zip

Beginner

A customer registry with query capabilities

customer-registry-quickstart.zip

Intermediate

A funds transfer workflow between two wallets

workflow-quickstart.zip

Intermediate

A user registration service implemented as a Choreography Saga

choreography-saga-quickstart.zip

Advanced
It is also possible to deploy a pre-built sample project in the Akka console, eliminating the need for local development.

Maven archetype

To create the build structure of a new service you can use the Maven archetype. From a command window, in the parent directory of the new service, run the following:

Linux or macOS
mvn archetype:generate \
  -DarchetypeGroupId=io.akka \
  -DarchetypeArtifactId=akka-javasdk-archetype \
  -DarchetypeVersion=3.0.2
Windows 10+
mvn archetype:generate ^
  -DarchetypeGroupId=io.akka ^
  -DarchetypeArtifactId=akka-javasdk-archetype ^
  -DarchetypeVersion=3.0.2

The Author your first Akka service starts from the Maven archetype and lets you implement a very simple service.