Football

About

This is a simple application to serve sportsbook players with data about seasons from certain football leagues. It is intended to provide only simple overviews around the seasons without any potential action from the user.

How it works

When starting the application, it will run a seeds file that will read from a seeds csv file all data that there is about matches and will consolidate that info into the database.

After this, any user can access that info through the public API. Since most data is simply read-only, there are not any data trickery (except on the season overview).

Using the application

Configuration

Environment variables

• FOOTBALL_DATABASE_USERNAME - optional - Sets the Database username
• FOOTBALL_DATABASE_PASSWORD - optional - Sets the Database user password
• FOOTBALL_DATABASE_HOSTNAME - optional - Sets the Database hostname
• FOOTBALL_DATABASE_URL - optional - Sets the Database connection url (if set, the connection will ignore the username, password and hostname passed before)

Compiling the application

This step is needed before executing any of the other actions (start server, test, document, ...)

On Docker

Build the image using the following command

sudo docker-compose -f "automation/docker/docker-compose.yml" build

Directly

If you don't want to use Docker, ensure that PostgreSQL is running then execute:

mix do deps.get, ecto.setup

Starting the server

On Docker

Note that starting the project on docker will start three instances of the server and a loadbalancer.

sudo docker-compose -f "automation/docker/docker-compose.yml" up

If this is the first time starting the server, with the containers up, run the seeds builder: TODO: Make this smarter or idempotent

sudo docker exec docker_football_1 mix ecto.setup

Access the server through http://localhost/api/leagues

Directly

mix phx.server

Access the server through http://localhost:4000/api/leagues

Testing the codebase

On docker

sudo docker exec docker_football_1 mix test

Directly

mix test

Generating documentation

This command will generate the application documentation on the application /doc folder.

On docker

TODO

Directly

mix docs

Application API

• Fetch all leagues

  /api/leagues
  

• Fetch all season within a league

  /api/leagues/<league_code>/seasons
  

• Fetch all data from a season (includes matches and season overview)

  /api/leagues/<league_code>/seasons/<season_code>
  

Note that resources returns links to related resources.

Project considerations

Load balancing

In this project, the same service (football) was specified three times to show load balancing with HAProxy without the need of more than one node or the use of an automation tool like Ansible.

If this was an application for the real world, it would have only a single definition of the football container to be deployed across several nodes and with the network data fed to the HAProxy node allowing it to balance load between them.

Database use

Since this project provides only a read-only RESTful API, it didn't need a database (data could be loaded from a file and kept in-memory), but a database was used to make it easier to include more data, provide more resource endpoints and to allow filtering data in the future.

Unimplemented features

Some features could not be implemented due to time constraints. Those are:

• Protocol Buffer
• Automatic API Documentation
• Loging instrumentation
• Metrics instrumentation

License

Copyright (c) 2018 Charlotte Lorelei Oliveira. This source code is released under GPL 3.

Check LICENSE or GNU GPL3 for more information.