Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 1.54 KB

README.md

File metadata and controls

85 lines (63 loc) · 1.54 KB
Raw

A simple battleship API

Installation

# Install Yarn
brew update
brew install yarn

# Clone the repo
git clone https://github.com/eakl/battleship
cd battleship

# Install dependencies
yarn

# Run tests
yarn test

# Start the server
yarn start

Usage

Once the server has started, you can use this simple API with cURL or Postman

Attack

To attack, just make a request to the attack endpoint with the query coord=X_Y. Where X and Y are your coordinates.

curl -X POST http://localhost:8080/attack?coord=X_Y

Example

Let's say the generated battlefield looks like the following:

[0,0,0,0,0,0,1,1,0,1]
[0,0,0,0,0,0,0,0,0,0]
[0,0,0,0,0,0,0,0,1,0]
[1,0,0,0,0,0,0,0,0,0]
[1,0,0,1,1,0,0,1,0,0]
[1,0,0,0,0,0,0,0,0,0]
[0,0,1,0,0,0,0,1,0,0]
[0,0,1,0,0,1,0,1,0,0]
[0,0,0,0,0,0,0,1,0,0]
[0,1,1,1,0,0,0,1,0,0]

By making the following requests:

curl -X POST http://localhost:8080/attack?coord=3_7
# Hit

curl -X POST http://localhost:8080/attack?coord=3_8
# You just sank the destroyer

You'll sink the destroyer and the battlefield will look like this:

[0,0,0,0,0,0,1,1,0,1]
[0,0,0,0,0,0,0,0,0,0]
[0,0,0,0,0,0,0,0,1,0]
[1,0,0,0,0,0,0,0,0,0]
[1,0,0,1,1,0,0,1,0,0]
[1,0,0,0,0,0,0,0,0,0]
[0,0,2,0,0,0,0,1,0,0]
[0,0,2,0,0,1,0,1,0,0]
[0,0,0,0,0,0,0,1,0,0]
[0,1,1,1,0,0,0,1,0,0]

The coordinates you hit are replaces by the 2's

Restart the game

curl -X GET http://localhost:8080/restart