Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mgjules/tic-tac-toe

TicTacToe is a simple Go microservice for the famous TicTacToe game.
https://github.com/mgjules/tic-tac-toe

firebase go golang microservice rest-api tic-tac-toe

Last synced: 11 days ago
JSON representation

TicTacToe is a simple Go microservice for the famous TicTacToe game.

Host: GitHub
URL: https://github.com/mgjules/tic-tac-toe
Owner: mgjules
License: apache-2.0
Created: 2021-01-22T23:31:01.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-08-21T15:48:42.000Z (about 1 year ago)
Last Synced: 2024-06-20T13:33:32.011Z (5 months ago)
Topics: firebase, go, golang, microservice, rest-api, tic-tac-toe
Language: Go
Homepage:
Size: 935 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # TicTacToe

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](https://godoc.org/github.com/mgjules/tic-tac-toe)

[![License](https://img.shields.io/badge/Apache%202.0-green.svg?style=for-the-badge)](LICENSE)

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

## Contents

- [TicTacToe](#tictactoe)

  - [Contents](#contents)

  - [Requirements](#requirements)

  - [Getting started](#getting-started)

  - [API Documentation](#api-documentation)

  - [Implementation Status](#implementation-status)

## Requirements

- Go v1.15.x installed

- [golangci-lint](https://github.com/golangci/golangci-lint) installed on your local machine

  - used for linting and detecting common errors

## Getting started

1. Download the Go dependencies

  

    ```console

    $ 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

    ```console

    $ make buildrun

    ```

## API Documentation

The microservice exposes a [Swagger UI](https://swagger.io/tools/swagger-ui/) interface on `http://${HOST}:${PORT}/swagger/index.html`.

## Implementation Status

- [x] Allow only one move per player, i.e. one after the other

- [x] Detect if a ‘POST /move’ call was made by a player or the Firebase function

- [x] Serve correct status codes and descriptive response bodies for invalid input

- [x] 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**.*

- [x] Provide unit tests