An open API service indexing awesome lists of open source software.

https://github.com/dmarcoux/elixir_templates

Templates for common files/configs in Elixir/Phoenix projects
https://github.com/dmarcoux/elixir_templates

docker docker-compose elixir nix phoenix

Last synced: 2 months ago
JSON representation

Templates for common files/configs in Elixir/Phoenix projects

Awesome Lists containing this project

README

          

# dmarcoux/elixir_templates

Templates for common files/configs in
[Elixir](https://elixir-lang.org/)/[Phoenix](https://www.phoenixframework.org/)
projects.

## How to Use This Template

1. Create a new repository based on this repository:

- Go to this [repository's page](https://github.com/dmarcoux/elixir_templates),
click on the `Use this template` button and follow instructions.

*OR*

- With [GitHub's CLI](https://github.com/cli/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](https://www.phoenixframework.org/) application, generate it with:

1. Set up [development environment](#development-environment):

```bash
mise install
```

2. Install [phx_new](https://hex.pm/packages/phx_new):

```bash
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:

```bash
mix phx.new . --app awesome_name
```

## Development Environment

Rely on [Mise](https://mise.jdx.dev/) to install tools, set environment
variables, and run tasks. Refer to [mise.toml](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:

```bash
mise install
```

See available tasks with:

```bash
mise run
```

## Continuous Integration with [GitHub Actions](https://docs.github.com/en/actions)

Linters, tests and more. Details under [.github/workflows](./.github/workflows).

## [Dependabot](https://dependabot.com/)

Automated dependency updates. Details in the [config](./.github/dependabot.yml).