Skip to content

koshacool/battleship

Repository files navigation

Battleship

Battleship (also Battleships or Sea Battle[1]) is a guessing game for two players. It is played on ruled grids (paper or board) on which each players fleet of ships (including battleships) are marked. The locations of the fleets are concealed from the other player. Players alternate turns calling "shots" at the other player's ships, and the objective of the game is to destroy the opposing player's fleet.

Demo

Tech stack

  • Angular
  • Rxjs
  • Firebase
  • Typescript
  • Bootstrap
  • @ngrx/store

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation and usage

Clone the repo

$ git clone git@github.com:koshacool/battleship.git yourFolderName
$ cd yourFolderName
$ npm i
$ npm start

Running the tests

To run the tests write in terminal:

$ npm run test

Deployment

We use Travis Ci for deployment. After merge changes into master branch the app will be automatically deployed to server (Battleship Demo).

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

TODO

  • Add second real pleyer
  • Improve game's logic (add different ships, add animation, etc)
  • Add filters to games list

Issue template

Pull Request

License

This project is licensed under the MIT License - see the LICENSE.md file for details