Developing a Gleam application

In this tutorial, you will learn how to add flake.nix to a Gleam project.

Initialize a new project

Caution

If you are trying to add flake.nix to an existing project, please skip this section.

1. Make gleam executable available:

   nix shell nixpkgs#gleam

2. Run gleam new to scaffold a new project:

   gleam new --skip-github 'your_new_project'

   By default, gleam new generates .github directory containing a CI workflow for running tests, but we don't need it as we will install Gleam using Nix.

3. Enter the directory:

   cd 'your_new_project'

Add flake.nix to the project

1. Initialize the template from the root directory of the project:

   nix flake init github:akirak/flake-templates#gleam

2. Open flake.nix and update the Erlang version to the current one:

   erlang_version = "erlang_26";
   erlang_version = "erlang_27";

3. Add .envrc:

   use flake

4. Allow direnv:

   direnv allow