[](REPO_URL goes here)

Introduction

App introduction goes here ...

Project Setup

Erlang & Elixir

• Erlang 24.2.2

• Elixir 1.13.3

• Recommended version manager.

  • asdf
  • asdf-erlang
  • asdf-elixir

Development

• Install Docker for Mac

• Setup and boot the Docker containers:

  make docker_setup

• Install Elixir dependencies:

  mix deps.get

• Install Node dependencies:

  npm install --prefix assets

• Setup the databases:

  mix ecto.setup

• Start the Phoenix app

  iex -S mix phx.server

• Run all tests:

  mix test 

• Run all lint:

  mix codebase 

• Fix all lint:

  mix codebase.fix 

• Test coverage:

  mix coverage 

Production

• Build Docker image

  docker-compose build

CI/CD

The project relies entirely on Github Actions for CI/CD via multiple workflows located under the .github/workflows/ directory. Please check out the .github/workflows/README.md file for further instructions.

Project documentation

Most of the documentation is located in the .github/wiki directory, which is published to the project's Github wiki.