FOSS Retro

This is a simple, real-time agile retrospective board built with Phoenix LiveView and OTP.

Getting Started

This is a Phoenix LiveView project. If you've never worked with Elixir or Phoenix, check out Elixir and Phoenix docs for instructions on how to install the necessary dependences:

• https://elixir-lang.org/install.html
• https://hexdocs.pm/phoenix/installation.html#content

If you use asdf for version management, you can also install Elixir via the official plugin.

Recommended Versions

• Erlang 23.2.7
• Elixir 1.11.3
• NodeJS 14.x.x
• Phoenix 1.5.x

Commands

mix setup

Installs the project's dependences

mix phx.server

Starts the Phoenix server

iex -S mix

Starts an interactive Elixir shell and loads-in the project's code

mix format

Auto-formats your Elixir code

MIX_ENV=test mix test

Runs the project's test suite