dmarcoux/elixir_templates

Templates for common files/configs in Elixir/Phoenix projects.

How to Use This Template

1. Create a new repository based on this repository:

• Go to this repository's page, click on the Use this template button and follow instructions.

  OR

• With GitHub's CLI, run gh repo create NEW_REPOSITORY_NAME --template=dmarcoux/elixir_templates.

2. Search for CHANGEME in the newly created repository to adapt it to your needs.

3. For a Phoenix application, generate it with:

   1. Set up development environment:

      mise install

   2. Install phx_new:

      mix archive.install hex phx_new 1.8.3

      Omit the version (1.8.3) to install latest version of phx_new.

   3. Generate the Phoenix application within the current directory:

      mix phx.new . --app awesome_name

Development Environment

Rely on Mise to install tools, set environment variables, and run tasks. Refer to mise.toml for details. The Mise documentation is there to help you get started, there's no need to repeat it all here. It boils down to activating Mise (optional), installing tools, and running tasks.

Install tools with:

mise install

See available tasks with:

mise run

Continuous Integration with GitHub Actions

Linters, tests and more. Details under .github/workflows.

Dependabot

Automated dependency updates. Details in the config.