{"id":13491525,"url":"https://github.com/mirego/elixir-boilerplate","last_synced_at":"2025-05-15T23:08:06.974Z","repository":{"id":40533511,"uuid":"176351806","full_name":"mirego/elixir-boilerplate","owner":"mirego","description":"⚗ The stable base upon which we build our Elixir projects at Mirego.","archived":false,"fork":false,"pushed_at":"2024-06-24T19:54:52.000Z","size":1559,"stargazers_count":1148,"open_issues_count":16,"forks_count":84,"subscribers_count":49,"default_branch":"main","last_synced_at":"2025-04-08T10:32:53.130Z","etag":null,"topics":["absinthe","absinthe-graphql","credo","dialyzer","docker","ecto","elixir","elixir-lang","elixir-phoenix","gettext","graphql","otp","plug"],"latest_commit_sha":null,"homepage":"https://open.mirego.com","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mirego.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-18T19:02:00.000Z","updated_at":"2025-03-28T13:35:05.000Z","dependencies_parsed_at":"2023-10-17T06:00:37.224Z","dependency_job_id":"cdd9ed49-1314-43d0-af13-14a472c9088f","html_url":"https://github.com/mirego/elixir-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirego%2Felixir-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirego%2Felixir-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirego%2Felixir-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirego%2Felixir-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mirego","download_url":"https://codeload.github.com/mirego/elixir-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436949,"owners_count":22070947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["absinthe","absinthe-graphql","credo","dialyzer","docker","ecto","elixir","elixir-lang","elixir-phoenix","gettext","graphql","otp","plug"],"created_at":"2024-07-31T19:00:57.856Z","updated_at":"2025-05-15T23:08:01.957Z","avatar_url":"https://github.com/mirego.png","language":"Elixir","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/11348/52080254-520cb580-2565-11e9-8c21-156cf0b7bcf3.png\" width=\"600\" /\u003e\n  \u003cp\u003e\u003cbr /\u003eThis repository is the stable base upon which we build our Elixir projects at Mirego.\u003cbr /\u003eWe want to share it with the world so you can build awesome Elixir applications too.\u003c/p\u003e\n  \u003ca href=\"https://github.com/mirego/elixir-boilerplate/actions/workflows/ci.yaml\"\u003e\u003cimg src=\"https://github.com/mirego/elixir-boilerplate/actions/workflows/ci.yaml/badge.svg\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Introduction\n\nTo learn more about _why_ we created and maintain this boilerplate project, read our [blog post](https://shift.mirego.com/en/boilerplate-projects).\n\n## Content\n\nThis boilerplate comes with batteries included, you’ll find:\n\n- [Phoenix](https://phoenixframework.org), the battle-tested production-ready web framework\n- Database integration using [Ecto](https://hexdocs.pm/ecto)\n- GraphQL API setup with [Absinthe](https://hexdocs.pm/absinthe), [Absinthe.Plug](https://hexdocs.pm/absinthe_plug), [Dataloader](https://hexdocs.pm/dataloader), [AbsintheErrorPayload](https://hexdocs.pm/absinthe_error_payload) and [AbsintheSecurity](https://hexdocs.pm/absinthe_security)\n- Translations with [Gettext](https://hexdocs.pm/gettext) and [Accent](https://www.accent.reviews) (using a scheduled GitHub Actions [workflow](./.github/workflows/accent.yaml))\n- [ExUnit](https://hexdocs.pm/ex_unit) tests, factories using [ExMachina](https://hexdocs.pm/ex_machina) and code coverage using [ExCoveralls](https://hexdocs.pm/excoveralls)\n- CORS management with [Corsica](https://github.com/whatyouhide/corsica)\n- Opinionated linting with [Credo](http://credo-ci.org)\n- Security scanning with [MixAudit](https://hex.pm/packages/mix_audit) and [Sobelow](https://hexdocs.pm/sobelow)\n- Healthcheck setup with [plug_checkup](https://hexdocs.pm/plug_checkup)\n- OTP release using [`mix release`](https://hexdocs.pm/mix/Mix.Tasks.Release.html) and [Docker](https://www.docker.com)\n- Useful utilities for web features: Basic authentication with [BasicAuth](https://hexdocs.pm/plug/Plug.BasicAuth.html), canonical host with [PlugCanonicalHost](https://hexdocs.pm/plug_canonical_host), etc.\n- Error reporting with [Sentry](https://hexdocs.pm/sentry)\n- A clean and useful `README.md` template (in both [english](./BOILERPLATE_README.md) and [french](./BOILERPLATE_README.fr.md))\n- Dashboard metrics using [TelemetryUI](https://github.com/mirego/telemetry_ui)\n\n## Usage\n\n### With GitHub template\n\n1. Click on the [**Use this template**](https://github.com/mirego/elixir-boilerplate/generate) button to create a new repository\n2. Clone your newly created project (`git clone https://github.com/you/repo.git`)\n3. Run the boilerplate setup script (`./boilerplate-setup.sh YourProjectName`)\n4. Commit the changes (`git commit -a -m \"Rename elixir-boilerplate parts\"`)\n\n### Without GitHub template\n\n1. Clone this project (`git clone https://github.com/mirego/elixir-boilerplate.git`)\n2. Delete the internal Git directory (`rm -rf .git`)\n3. Run the boilerplate setup script (`./boilerplate-setup.sh YourProjectName`)\n4. Create a new Git repository (`git init`)\n5. Create the initial Git commit (`git commit -a -m \"Initial commit\"`)\n\n## Preferred libraries\n\nSome 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:\n\n| Category                    | Libraries                                                                              |\n| --------------------------- | -------------------------------------------------------------------------------------- |\n| Authentication              | [`ueberauth`](https://hex.pm/packages/ueberauth), [`pow`](https://hex.pm/packages/pow) |\n| Asynchronous job processing | [`oban`](https://hex.pm/packages/oban)                                                 |\n| Emails                      | [`bamboo`](https://hex.pm/packages/bamboo), [`swoosh`](https://hex.pm/packages/swoosh) |\n| File upload                 | [`waffle`](https://hex.pm/packages/waffle)                                             |\n| HTTP client                 | [`tesla`](https://hex.pm/packages/tesla)                                               |\n| HTML parsing                | [`floki`](https://hex.pm/packages/floki)                                               |\n| Pagination                  | [`scrivener`](https://hex.pm/packages/scrivener)                                       |\n| Mocks                       | [`mox`](https://hex.pm/packages/mox), [`mimic`](https://hex.pm/packages/mimic)         |\n| Search                      | [`elasticsearch`](https://hex.pm/packages/elasticsearch)                               |\n\n## License\n\nElixir Boilerplate is © 2017-2020 [Mirego](https://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the [`LICENSE.md`](https://github.com/mirego/elixir-boilerplate/blob/main/LICENSE.md) file.\n\nThe drop logo is based on [this lovely icon by Creative Stall](https://thenounproject.com/term/drop/174999), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.\n\n## About Mirego\n\n[Mirego](https://www.mirego.com) 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](https://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://www.mirego.org).\n\nWe also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.\n","funding_links":[],"categories":["Elixir"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirego%2Felixir-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirego%2Felixir-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirego%2Felixir-boilerplate/lists"}