umamaistempo/football

football's Issues

Expose API Resource - /leagues/_/seasons/_

API

@spec show(%{
  required(:league) => String.t,
  required(:season) => String.t
}) :: %{
  data: %{
    games_count: non_neg_integer,
    overview: [
      %{
        team: String.t,
        games: non_neg_integer,
        wins: non_neg_integer,
        losses: non_neg_integer,
        draws: non_neg_integer,
        goals: non_neg_integer
      }
    ],
    games: [
      %{
        home_team: String.t,
        away_team: String.t,
        game_date: Date.t,
        half_time_result: :home | :draw | :away,
        full_time_result: :home | :draw | :away,
        half_time_home_goals: non_neg_integer,
        half_time_away_goals: non_neg_integer,
        full_time_home_goals: non_neg_integer,
        full_time_away_goals: non_neg_integer
      }
    ]
  }
}

TODO: Consider if using HATEOAS

Metrics - Datadog integration

Logging - Sentry integration

Include Dialyzer into the pipeline

Continuous Integration - Configure Travis CI

Expose API resource - /leagues/_

@spec show(%{}) :: %{
  data: %{
    name: String.t
  }
}

Prepare Docker image

Prepare HAProxy

Code Review - Configure Ebert

Test coverage - Configure Coveralls

Configure PostgreSQL

Having a relational database will make filtered queries easier and more versatile

Documentation coverage - Configure Inch CI

Expose API resource - /leagues/_/seasons

@spec index(%{
  required(:league) => String.t
}) :: %{
  data: %{
    seasons: [
      %{
        id: String.t,
        games_count: non_neg_integer
      }
    ]
  }
}

Support protobuff

Consider Ansible for automation

API Documentation - Apiary