Awesome
<div align="center"> <img src="https://user-images.githubusercontent.com/11348/52080254-520cb580-2565-11e9-8c21-156cf0b7bcf3.png" width="600" /> <p><br />This repository is the stable base upon which we build our Elixir projects at Mirego.<br />We want to share it with the world so you can build awesome Elixir applications too.</p> <a href="https://github.com/mirego/elixir-boilerplate/actions/workflows/ci.yaml"><img src="https://github.com/mirego/elixir-boilerplate/actions/workflows/ci.yaml/badge.svg" /></a> </div>Introduction
To learn more about why we created and maintain this boilerplate project, read our blog post.
Content
This boilerplate comes with batteries included, you’ll find:
- Phoenix, the battle-tested production-ready web framework
- Database integration using Ecto
- GraphQL API setup with Absinthe, Absinthe.Plug, Dataloader, AbsintheErrorPayload and AbsintheSecurity
- Translations with Gettext and Accent (using a scheduled GitHub Actions workflow)
- ExUnit tests, factories using ExMachina and code coverage using ExCoveralls
- CORS management with Corsica
- Opinionated linting with Credo
- Security scanning with MixAudit and Sobelow
- Healthcheck setup with plug_checkup
- OTP release using
mix releaseand Docker - Useful utilities for web features: Basic authentication with BasicAuth, canonical host with PlugCanonicalHost, etc.
- Error reporting with Sentry
- A clean and useful
README.mdtemplate (in both english and french) - Dashboard metrics using TelemetryUI
Usage
With GitHub template
- Click on the Use this template button to create a new repository
- Clone your newly created project (
git clone https://github.com/you/repo.git) - Run the boilerplate setup script (
./boilerplate-setup.sh YourProjectName) - Commit the changes (
git commit -a -m "Rename elixir-boilerplate parts")
Without GitHub template
- Clone this project (
git clone https://github.com/mirego/elixir-boilerplate.git) - Delete the internal Git directory (
rm -rf .git) - Run the boilerplate setup script (
./boilerplate-setup.sh YourProjectName) - Create a new Git repository (
git init) - Create the initial Git commit (
git commit -a -m "Initial commit")
Preferred libraries
Some batteries aren’t included since all projects have their own needs and requirements. Here’s a list of our preferred libraries to help you get started:
| Category | Libraries |
|---|---|
| Authentication | ueberauth, pow |
| Asynchronous job processing | oban |
| Emails | bamboo, swoosh |
| File upload | waffle |
| HTTP client | tesla |
| HTML parsing | floki |
| Pagination | scrivener |
| Mocks | mox, mimic |
| Search | elasticsearch |
License
Elixir Boilerplate is © 2017-2020 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md file.
The drop logo is based on this lovely icon by Creative Stall, from The Noun Project. Used under a Creative Commons BY 3.0 license.
About Mirego
Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.
We also love open-source software and we try to give back to the community as much as we can.