This project is a Pictionary game implemented with Python and Docker. It's designed for anyone who wants to play Pictionary online with their friends.
- Clone the repository and navigate to the project directory.
- If not running in a container, create a Python virtual environment using the following command:
python3 -m pipenv shell - Run the app using Docker Compose:
docker-compose upor use commandmake up - To shut down the app and remove all images, use:
docker-compose down --rmi allor use commandmake down - OR just do
make all
- pytest tests/unit -s
- OR
make test
- pytest --cov=./ tests/
- Health check:
/v1/health - Room operations:
- Create Room:
/v1/create-room - Join Room:
/v1/join-room - Fetch Room:
/v1/fetch-rooms - Fetch Players:
/v1/fetch-players
- Create Room: