Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xabdulkhaliq/battleship
Command your fleet and conquer the seas in our Battleship showdown!
https://github.com/0xabdulkhaliq/battleship
animation battleship css es6-modules html jest npm tdd webpack
Last synced: 12 days ago
JSON representation
Command your fleet and conquer the seas in our Battleship showdown!
- Host: GitHub
- URL: https://github.com/0xabdulkhaliq/battleship
- Owner: 0xabdulkhaliq
- License: mit
- Created: 2023-11-13T14:25:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-22T09:55:04.000Z (12 months ago)
- Last Synced: 2024-08-14T03:38:13.128Z (3 months ago)
- Topics: animation, battleship, css, es6-modules, html, jest, npm, tdd, webpack
- Language: JavaScript
- Homepage: https://battleship-0xabdulkhalid.vercel.app
- Size: 271 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**❝** Command your fleet and conquer the seas in our Battleship showdown! **❞**
❯
View Demo
·
Report Bug
·
Request Feature
❮
## Project Overview
- Battleship project was crafted with the main goal of exploring **Test-Driven Development (TDD)** using **Jest**.
- Built during partial completion of Odin Project's Full-Stack JavaScript Path.
- Each essential modules like Player, Gameboard, and Ship were meticulously tested before diving into the user interface (UI) development.
- This approach ensures a robust foundation, allowing for a smooth and reliable gaming experience.
- I have additional features to incorporate; however, due to time constraints, I will address them in the future.
## Learn to Play Battleship
- If you're already familiar with the rules of Battleship, you can skip this section.
- However, if you're new to the game or need a quick refresher, you can read the [Game's Manual](https://en.wikipedia.org/wiki/Battleship_(game)) on Wikipedia.
- For a visual guide, check out this [video tutorial](https://youtu.be/RY4nAyRgkLo) on Youtube.
## Installation
> [!NOTE]
> If you prefer not to install it locally, you can also access the [live demo](https://battleship-0xabdulkhalid.vercel.app/) version
To set up the Battleship Application locally, follow these steps:
1. Clone the GitHub repository to your local machine:
```bash
git clone https://github.com/0xabdulkhalid/battleship.git
```
2. Navigate to the project's directory:
```bash
cd battleship
```
3. Install the project's dependencies using npm:
```bash
npm install
```
4. Build the project to bundle JavaScript, minify HTML and CSS, and move images:
```bash
npm run build
```
5. The build files can be found on `dist` (distribution) directory.
## Pagespeed Insights Score
- ||
| :-----: |
| Overall Score 99.4%, Average of Mobile and Desktop
[ Mobile devices score is only shown below ] |
| |
| 
|
| |
| Check out [**Pagespeed Insights**](https://pagespeed.web.dev/analysis/https-battleship-0xabdulkhalid-vercel-app/88ptn9rxjc?form_factor=mobile) to get live score |
||
## Built With
     
## Tools Used
    
   
## Let's Connect 👋
