AlexandruRoman / heartball-game-frontend

Heartball

A football cards game built using React

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

Heartball is a turn based football card game. Every round is played online by 2 users. The multiplayer system is implemented with Socket.io.

Built With

• React
• Redux
• TypeScript
• SocketIO

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Install Node.js

Installation

1. Clone the repo

git clone https://github.com/AlexandruRoman/heartball-game-frontend.git

2. Install NPM packages

npm install

3. Enter your API url in src/App.tsx

    this.socket = io.connect('YOUR API URL');
})

Usage

Running the app in dev mode:

npm start

Creating a production build of the app:

npm run build

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.