Contributing

Make sure to have docker-compose installed.

Running the application locally

Enter the development container:

git clone https://github.com/felipelincoln/graph-banking.git
cd graph-banking/
docker-compose run --service-ports --rm web /bin/sh

Create the database, run migrations and start the server:

mix ecto.setup
mix phx.server

Alternatively (when the database is already created), you can fast start the services:

docker-compose up

Test pipeline

Good practice to run before making commits. It will mirror our GitHub action.

Run the following inside the container:

mix ci

This will run:

mix format --check-formatted --dry-run
mix credo --strict
mix coveralls

Building documentation

Run whenever your changes may cause documentation changes.

Run the following inside the container:

mix docs