Minesweeper Backend

Stack used:

• Python 3.8
• Django 3.1.3
• Django Rest Framework
• MySQL 8
• Black and Flake8 for codestyling
• APICURIO, for API documentation
• Docker
• Sentry for error tracking

OpenAPI 3 documentation: https://apidoc.mines.makecodes.dev/ Game frontend: https://mines.makecodes.dev/ Frontend github repo: https://github.com/imakecodes/minesweeper-frontend

Production environment

Was used Digital Ocean to host the applications using a little droplet with 1GB/25GB with Ubuntu 20.04 LTS at New York with Docker and Nginx(for reverse proxy).

Also was used Github Actions to create docker images for backend and frontend

Next desired steps

• Change the primary key of the game from Integer to UUID to avoid cheating from the players
• User authentication to store the match history
• Create a global and by user scoreboard
• Create unit tests

Running locally

Assuming you have docker-compose and docker installed on your computer:

Clone the repository

git clone [email protected]:imakecodes/minesweeper-backend.git
cd minesweeper-backend

Run the application

docker-compose up -d

Run the migrations

docker-compose run app python manage.py migrate

The application will be available at http://localhost:8000