/minesweeper

Primary LanguageGo



Minesweeper-Service

Service API for game mineswipeer.

List of items completed • Dependencies • Technologies • How To Use • Documentation • Contributing

List of items completed

  • Design and implement a documented RESTful API for the game (think of a mobile app for your API)
  • Implement an API client library for the API designed above. Ideally, in a different language, of your preference, to the one used for the API
  • When a cell with no adjacent mines is revealed, all adjacent squares will be revealed (and repeat)
  • Ability to 'flag' a cell with a question mark or red flag
  • Detect when game is over

Technologies

Dependencies

How To Use

Running the project

Before running the project please ensure that all the dependencies are installed in your system. Then follow the next:

  1. Run the project itself

    go run

Running the tests

In order to run the project tests you need to execute the following command:

go test -cover -covermode=count  ./...

Generate API Documentation (Swagger)

This project has a swagger documentation. To re-generate that documentation execute the following command:

swagger generate spec -o ./swagger.yaml

Documentation

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Make your changes
  4. Run the tests, adding new ones for your own code if necessary (junit5)
  5. Commit your changes (git commit -am 'Added some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request