Getting started

September 2, 2022 ยท View on GitHub

Commanded can be installed from the package manager hex as follows.

  1. Add commanded to your list of dependencies in mix.exs:

    def deps do
  [{:commanded, "~> 1.4"}]
end

  2. Optionally add jason to support JSON serialization via Commanded.Serialization.JsonSerializer:

    def deps do
  [{:jason, "~> 1.3"}]
end

  3. Fetch mix dependencies:

    $ mix deps.get

  4. Define a Commanded application module for your app, see the Application guide for details.

    defmodule MyApp.Application do
  use Commanded.Application, otp_app: :my_app
end

  5. Configure one of the supported event stores by following the Choosing an Event Store guide.