This is a version of the classic board game Battleship, built using TypeScript and Test-Driven Development (TDD).
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js
- npm
-
Clone the repo
git clone https://github.com/Bradley-Hill/odinproject-battleship.git
-
Install NPM packages
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
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the ISC License.
Bradley M. Hill - @kingmObYojimbo - brad.michael.hill@gmail.com
Project Link: https://github.com/Bradley-Hill/odinproject-battleship