README.md

App

NflRushing is an app that show data about NFL players and stats. The app contain the following bahaviors:

• Filter by name
• Sort ASC/DESC by YDS, TD, LNG
• Download filtered/sorted data to a CSV
• Download the whole data to a CSV
• Paginated results with a default of 25 records per page

App is deployed and running on Gigalixir https://nflrushing.gigalixirapp.com/

Stack

The solution was built using:

• Elixir 1.12
• Phoenix 1.6
• PostgreSQL 12

Installation & Setup

It requires you to have the same stack installed.

If you are using bash you need ro run:

source .bash_env

If you are using fish as me, you need to run:

source .fish_env

Both commands will set the env variables for POSTGRES_USER, POSTGRES_PASSWORD and POSTGRES_HOST to later be used on test and dev env.

Once env variables are set is possible to setup the DB for both envs

mix ecto.create; mix ecto.migrate

MIX_ENV=test mix ecto.create; mix ecto.migrate

Running the app

First needs to load the data from rushing.json file:

mix run priv/repo/seeds.exs

The data will be loaded in batchs of 50, is possible to change this value by editing priv/repo/seeds.exs file.

Once the data is loaded the app can run by:

iex -S mix phx.server

It will run the app and also open the iex console. If you do not wanna the iex console just run mix phx.server

Running test

Tests were developed using the default ExUnit framework and can be used by running:

mix test

Formating and code styles

Is it possible to use credo, format and also Dialyzer to static code check by running.

mix credo; mix format; mix dialyzer;

https://www.mitchellhanberg.com/ci-cd-with-phoenix-github-actions-and-gigalixir/