stokid / Torpedo-Game-React

Torpedo-Game-React

Table of Contents

1. About The Project
2. Project preview
3. Languages
4. Getting Started
   • Prerequisites
   • Installation
   • Run in Docker
5. License

About The Project

I have just made a classic Torpedo / Battleship game from our childhood. It is a two-person game which playable in browser with PC or Smartphone. The game's screen can orient your device when you refresh the page. So you can play on stationary also landscape screen. The game has a chat component where the Bot helps you what you have to do.

Project preview

Languages

The page's language available just Hungarian at now, but also prepared in English. Even so the Torpedo is playable very easy.

• Hungarian
• English (prepare)

Getting Started

You can run the app on your OS, or it also can be run in Docker container. If you would like run in Docker, you don not have to install npm package, because of Docker do it when image is created.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/stokid/Torpedo-Game-React.git

2. Install NPM packages

   npm install

3. Start the app

   npm start

Run in Docker

At first enter the folder where Dockerfile can be found.

Build image:

  docker build -t torpedo-game-react .

Start container:

On Windows:

  docker container run -p 3000:3000 -v ${PWD}:/frontend/torpedo -v /frontend/torpedo/node_modules -v /frontend/torpedo/.git --name torpedo-game-react-app torpedo-game-react

On Mac:

   docker container run -p 3000:3000 -v $PWD:/frontend/torpedo -v /frontend/torpedo/node_modules -v /frontend/torpedo/.git --name torpedo-game-react-app torpedo-game-react

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)