BattleShift

• An API for multi-player battleship.
• This is a brownfield project built on top of an existing battleship game for a single player and computer. Players sign up for an account, and will receive an email with their API key and a link to activate their account. Once activated, they are able to send post requests using their API key to create a new game, place their ships and fire shots on the opposing player.
• The deployed version can be found here: [BattleShift] (https://immense-woodland-83336.herokuapp.com/)
• The spec for this project can be found here: Project Spec

Getting Started

To run this application locally for testing and development, clone this repo and follow the steps below:

Bundle: $ bundle

Set up the database: $ rake db:create $ rake db:migrate

Start up your rails server with rails s and open localhost:3000 in your browser.

Prerequisites

Ruby Version: 2.4+ Rails Version: 5+

Running the tests

To run the test suite, run rspec from the root directory in your terminal after following the Getting Started instructions above.

Built With

• factorybot
• shoulda matchers
• capybara
• The original brownfield application: Original Battleshift
• The spec harness used to drive functionality: Spec Harness

Deployment

Visit the application deployed to Heroku here. Register for an account then check your email for your API key and account activation. This application requires Postman or your favorite tool to post HTTP requests to the API.

Authors

• Margaret Williford
• Megan Arellano