https://github.com/shravzzv/odin-battleship-project
Experience classic naval warfare in this digital rendition of Battleship. Strategically position your fleet, engage in thrilling battles against an AI opponent, and aim for victory on the high seas.
https://github.com/shravzzv/odin-battleship-project
battleship battleship-game css javascript theodinproject webpack
Last synced: 6 months ago
JSON representation
Experience classic naval warfare in this digital rendition of Battleship. Strategically position your fleet, engage in thrilling battles against an AI opponent, and aim for victory on the high seas.
- Host: GitHub
- URL: https://github.com/shravzzv/odin-battleship-project
- Owner: shravzzv
- Created: 2023-11-29T16:06:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T16:16:29.000Z (almost 2 years ago)
- Last Synced: 2023-12-19T11:46:25.710Z (almost 2 years ago)
- Topics: battleship, battleship-game, css, javascript, theodinproject, webpack
- Language: JavaScript
- Homepage: https://odin-battleship-project.vercel.app
- Size: 133 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Battleship
[Project demo](https://odin-battleship-project.vercel.app/)
## Description
Battleship is a web-based implementation of the classic board game. The game allows players to strategically place their ships on the board and engage in battles with an intelligent computer opponent. It provides an interactive and challenging gaming experience, staying true to the essence of the traditional Battleship game.
The project is part of [The Odin Project](https://www.theodinproject.com/) curriculum. Look [here](https://www.theodinproject.com/lessons/node-path-javascript-battleship) for the project source and description.
## Features
- **Ship Placement:** Strategically place your ships on the board, ensuring they are not adjacent to each other for a fair challenge.
- **Intelligent Computer Opponent:** Face off against a smart computer opponent that retaliates with tactical moves, adding an extra layer of challenge to the game.
- **Immersive Experience:** Enjoy sounds and animations that bring the game to life, adding a lively touch to your Battleship experience.
## Technologies Used
[](https://skillicons.dev)
## Installation
To install the project, follow these steps:
```bash
git clone https://github.com/shravzzv/ODIN-Battleship-project
cd ODIN-Battleship-project
npm install
```
Open the `dist/index.html` in your browser.
If you want to build on top of this project, you need to run the script `npm run dev` to be able to view your changes. Check the [package.json](package.json) for more details.
## How to Contribute
If you'd like to contribute, follow these steps:
1. Fork the repository on GitHub.
2. Clone your fork locally.
```bash
git clone https://github.com/shravzzv/ODIN-Battleship-project
cd project-folder
```
3. Create a new branch for your feature or bug fix.
```bash
git checkout -b feature-or-bug-fix-name
```
4. Make your changes, commit them, and push them to your fork.
```bash
git add .
git commit -m "Your commit message here"
git push origin feature-or-bug-fix-name
```
5. Open a Pull Request on GitHub, comparing your branch to the original repository's `main` branch.
## Issue Tracker
Find a bug or want to request a new feature? Please let us know by submitting an issue.
- [Issue Tracker](https://github.com/shravzzv/ODIN-Battleship-project/issues)
## License
This project is licensed under the MIT License - see the [LICENCE](LICENCE) file for details.
---