alex-min / ex_platform

A battery-included 🔋 Phoenix boilerplate

ExPlatform, a battery-included battery Phoenix boilerplate!

https://alex-min.fr/open-sourcing-my-phoenix-boilerplate/

What's included out of the box:

• TailwindCSS with Tailwind jit
• Esbuild & Postcss, no webpack
• Phoenix auth integrated with nice Tailwind pages and transformed to support i18n
• i18n everywhere (PRs are welcomed to add more languages)
• Notifications with a nice animation and auto-clear
• Auth emails are using Bamboo and proper HTML template
• Javascripts tests with Jest (and I've included some built-in tests)
• Pre-commit checks for styling & dialyzer (this boilerplate is ready for team work)
• Github actions checking the pre-commits and the tests for each commit
• Dependabot
• Asdf integration, just use the .tools-versions for all your versions! It's also what's used in the Github actions.
• Eslint
• Kaffy admin (on /admin)
• Sentry
• Deployment with Docker

Future integrations:

• A pricing page connected to Stripe
• A landing page
• Mobile view
• ...

Please send a PR if you have some good features you would like to integrate to ExPlatform.

Setting up the boilerplate

Install asdf

Please install asdf which can install all the tooling required.

git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.8.0
echo '. $HOME/.asdf/asdf.sh' >> ~/.bashrc

then restart bash and install all the plugins:

asdf plugin-add python
asdf plugin-add erlang
asdf plugin-add elixir
asdf plugin-add nodejs

Install all the tools:

asdf install

Install pre-commit

https://pre-commit.com/

Pre-commit checks your changes every time you do a commit.

pip install pre-commit
pre-commit install

Launching the server

mix deps.get
mix ecto.setup
mix phx.server

Tests

mix test   # Elixir tests
mix testjs # Javascript tests

updating locales

mix gettext.extract
mix gettext.merge priv/gettext/ --locale en
mix gettext.merge priv/gettext/ --locale fr
# ... other locales

ex_platform's Issues

Thoughts on pre-commit via asdf plug-in?

My mac (macOS 11.2.3) gave me a bit of trouble with pre-commit. Pip said it installed it, but it failed to add it to my path. I ended up using the pre-commit asdf plugin to work around the problem.

Since you are using asdf for everything else, what do you think about adding pre-commit to .tool-versions and letting the 'asdf install' step handle it?

Why is Ruby a dependency?

A little odd that Ruby is a dependency for an Elixir app. Why do I need to install Ruby?

Is asdf required?

Looks like you have done some nice work here. Is asdf required to use if I already have elixir/phoenix/node running in containers?

Add a rename script

This is a wonderful boilerplate template! Thanks a lot!
May I suggest to add a rename script similar to https://github.com/mirego/elixir-boilerplate/blob/master/boilerplate-setup.sh
That would make the setup even easier!