View Source Getting Started

There are a few steps needed to get started with the Ecspanse ECS framework. This guide covers the process of setting up the environment and creating a working application.

Create a new Elixir/Phoenix project

This guide we will use a simple supervised Elixir application:

mix new demo --sup

Installation

The first step is adding the :ecspanse library to the project dependencies. This is done by adding the following line to the mix.exs file:

def deps do
  [
    {:ecspanse, "~> 0.9.0"}
  ]
end

Setup

The subsequent stage involves configuring Ecspanse via use Ecspanse. In this guide, the primary Demo module will accommodate the Ecspanse setup:

defmodule Demo do
  use Ecspanse

  @impl Ecspanse
  def setup(data) do
    data
  end
end

The Ecspanse.setup/1 callback is mandatory. It will be used later on to schedule the application systems.

Starting the Ecspanse server

The module invoking use Ecspanse needs to be added to the aplication supervision tree.

defmodule Demo.Application do
  @moduledoc false

  use Application

  @impl true
  def start(_type, _args) do
    children = [
      Demo
    ]

    opts = [strategy: :one_for_one, name: Demo.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

The Ecspanse server loop will start together with the application:

iex -S mix