davidbrusius / uscore

User score system

UScore

UScore is a User Scoring API that keeps track of user points over time.

GitHub Pull Requests contain valuable information about decisions made during the coding process. Please refer to them for more details.

Requirements

• Docker

Setup

This setup covers installation using Docker. Make sure you have it up and running before continuing.

Clone the repository into your local machine:

$ git clone [e-mail]:davidbrusius/uscore.git

Switch to the project directory:

cd uscore

Build docker images:

docker-compose build

Setup UScore database:

docker-compose run uscore mix ecto.setup

All done! You can now run the UScore API!

Running

Run the UScore API:

$ docker-compose up -d

Watch application logs:

$ docker-compose logs -f

The API will be available at http://localhost:4000

Important: on the first run all users will have 0 points so you will need to wait for the first 1 minute interval to see users being returned by the API.

Shutdown the UScore API:

$ docker-compose down --remove-orphans

Run tests:

docker-compose run uscore mix test