📎 Webclip
Adding Gleam to your Elixir project
The page explains how to integrate Gleam, a strongly typed BEAM language built with rebar3, into an Elixir project by using a Phoenix umbrella. It walks through creating an umbrella app, replacing one Mix app with a Gleam app, configuring Mix to compile it via rebar3, fixing umbrella warnings by explicitly listing apps, and finally calling a Gleam function from a Phoenix controller. It also notes how to run tests for both Mix and rebar3 projects with a single shell command.
Reading notes#
- Gleam is a new BEAM language focused on strong type safety and is described as worth experimenting with.
- Gleam compiles to Erlang and uses rebar3 as its build tool, which Mix can work with without extra tooling.
- The setup uses a Phoenix umbrella application, where one app is Elixir and the other is Gleam.
- A new Phoenix umbrella app is generated with
mix phx.new --umbrella gleam_example. - The generated
apps/gleam_exampleMix app is removed so that a fresh Gleam application can be created in its place. - Gleam and rebar3 should be installed, and
asdfis suggested as an easy way to install them. - A new Gleam application is created with
gleam new gleam_example, which generates a standard Gleam project structure. - After creating the Gleam app, you can change into its directory and run tests using
rebar3 eunitto confirm the setup works. - To connect the Gleam app to the umbrella, Mix must be told to use rebar3 for that dependency in
apps/gleam_example_web/mix.exs. - In the web app’s
depsfunction, the umbrella dependency{:gleam_example, in_umbrella: true}is extended withmanager: :rebar3so Mix compiles it via rebar3. - Starting the Phoenix server at this point works but triggers a Mix warning that
apps/gleam_exampleis a directory without amix.exsfile. - Mix assumes all directories under
appsare Mix projects because of theapps_path: "apps"configuration in the top‑levelmix.exs. - To silence the warning, the project configuration is updated to include an explicit
apps: [:gleam_example_web]key. - With
apps: [:gleam_example_web], Mix compiles only the Elixir web application and ignores the Gleam app as a Mix project. - After configuration, the server can be started with
mix phx.serverwithout warnings, while still using the Gleam code. - The example integrates Gleam into the Phoenix app by calling a Gleam function from
GleamExampleWeb.PageController. - The controller’s
index/2action usestext(conn, :gleam_example.hello_world()), showing how a Gleam function compiled to Erlang can be invoked from Elixir. - This setup results in a Phoenix application that successfully calls Gleam code at runtime.
- Mix does not automatically run tests for rebar3 projects when executing
mix testin the umbrella. - To run all tests with one command, the author suggests a shell or Makefile command:
mix test && (cd apps/gleam_example && rebar3 eunit). - The completed example project demonstrating this integration is available on GitHub at
devonestes/gleam_example.
