Installation

You can run this project locally or in a Docker container.

Using Docker

• cd docker
• docker-compose build
• docker-compose up

Using Elixir locally

Requirements

• You need Elixir 1.18 or later and Erlang 27 or later. Run elixir -v to find your current version for Elixir and Erlang. You can also use mise or asdf to manage your Elixir and Erlang versions.
• Install Hex: mix local.hex.
• Install Phoenix: mix archive.install hex phx_new.
• PostgreSQL 17+.
• (Linux users only): inotify-tools.

Getting started

• Install dependencies and set up both the database and assets: mix setup.

Local development

• Start a local server: mix phx.server.
• Run tests: mix test or mix test.watch for live reloading.
• Update translation files: mix locale.

UI Preview

• You can have a preview of every UI component in the /lib/zoonk_dev/ui_preview folder. To do so, run mix phx.server and open your browser at http://localhost:4000/ui.