Skip to content

Bradley-Hill/navigator-battleship

Repository files navigation

Battleship Game

This is a version of the classic board game Battleship, built using TypeScript and Test-Driven Development (TDD).

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js
  • npm

Installation

  1. Clone the repo

    git clone https://github.com/Bradley-Hill/odinproject-battleship.git
  2. Install NPM packages

Usage

To start the game, run the following command:

npm run start

To build the project, run:

npm run build

To run the tests, use:

npm test

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the ISC License.

Contact

Bradley M. Hill - @kingmObYojimbo - brad.michael.hill@gmail.com

Project Link: https://github.com/Bradley-Hill/odinproject-battleship

About

Coding a version of Battleship(board game) using TDD

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published