Skip to content

danieladarve/Elixir-Boilerplate

Repository files navigation

Content

  • Phoenix, the battle-tested production-ready web framework
  • Database integration using Ecto
  • Translations with Gettext
  • ExUnit tests and code coverage using ExCoveralls
  • CORS management with Corsica
  • Opinionated linting with Credo
  • OTP release using Distillery and Docker
  • Useful utilities for web features: basic auth, canonical host, etc…
  • Error reporting with Sentry

Usage

With GitHub template

  1. Click on the [Use this template]button to create a new repository
  2. Clone your newly created project (git clone https://github.com/you/repo.git)
  3. Run the boilerplate setup script (./boilerplate-setup.sh YourProjectName)
  4. Commit the changes (git commit -a -m "Rename elixir-boilerplate parts")

Without GitHub template

  1. Clone this project
  2. Delete the internal Git directory (rm -rf .git)
  3. Run the boilerplate setup script (./boilerplate-setup.sh YourProjectName)
  4. Create a new Git repository (git init)
  5. Create the initial Git commit (git commit -a -m "Initial commit")