In order to release 0.1, Battleship Server needs to:
- Create an API to register a new Player
- Create an API to create a new Match
- Create a lobby to make players to wait until a match is ready.
- Separate players into matches of X configurable players.
- Create two Docker files: one with hot deploying for local development and other to run a stable version.
- Define Match structure containing Players and Events
- Create a throttling engine based on Time Frame to avoid API abuses
- Limit a Match by a configurable time and make an API endpoint to expose Match Results
- Create and API to register events in a given Match
- Make sure that the source code is well covered with tests (80%?)
- Use tools from CNCF stack
- Make a Kubernetes POD Configuration Yaml with all the stack needed to run and monitor the server
- Add a Gateway to protect the API by validating a JWT header
This project provides a Makefile with all common operations need to develop, test and build battleship-server.
- build: generates binaries
- test: runs all tests
- clean: removes binaries
- run: executes main func
- fmt: runs gofmt for all go files
Tests were write using Testify. In order to run them, just type:
$ make test