World Cup Challenger

Intro

This API was built to manage a World Cup, described as Tournament.

Running with Docker

First, check that you have a docker and a docker-compose on your machine with these commands:

docker -v
docker-compose -v

If not, check this tutorial for installation from the official Docker Docs documents

After the complete installation, you can build the project with this command at the root of the project

docker build .

Warning: This project uses PostgreSQL, so you may have to turn off your local instance of postgresql

To run and access localhost:8000:

docker-compose up

If you want to run in the background:

docker-compose up -d

To perform the tests (with the docker in the background):

docker-compose exec web python manage.py test

Endpoint documentation

All documentation of endpoints are described and built with Postman

You can check here