pfantato/elixir-portal

Small beginner elixir project

Elixir Portal

This is a small learning project to improve my knowledge in Elixir lang, and will be improved from time to time to practice my skills.

How to setup the dev environment

You need to clone the repo and run mix deps.get to install the deps of the project.

git clone git@github.com:pfantato/elixir-portal.git
cd elixir-portal
mix deps.get

Project documentation

Documentation are generated with ExDoc.

mix docs

Actions

There is an Action configured to build docs on all pushes to main branch. It will generate the docs and push to gh-pages branch, which will trigger the Action to build GitHub Pages and generate the project docs and publish it.