tic-tac-toe

TicTacToe

TicTacToe is a small microservice that acts as the backend for a tic tac toe game by using the Firebase realtime database.

Contents

• TicTacToe
  • Contents
  • Requirements
  • Getting started
  • API Documentation
  • Implementation Status

Requirements

• Go v1.15.x installed
• golangci-lint installed on your local machine
  • used for linting and detecting common errors

Getting started

1. Download the Go dependencies

   $ go mod download
   

2. Clone (i.e make a copy) .env.example to .env and modify it as needed

3. Build and execute the microservice

   $ make buildrun
   

API Documentation

The microservice exposes a Swagger UI interface on http://${HOST}:${PORT}/swagger/index.html.

Implementation Status

• Allow only one move per player, i.e. one after the other
• Detect if a ‘POST /move’ call was made by a player or the Firebase function
• Serve correct status codes and descriptive response bodies for invalid input
• Sanity check input and game state
• Bonus points for detecting if a game will result in a draw / deadlock early on
  • Detection does not happen early on.
• Provide unit tests