Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/indiecodermm/chess-arena

Chess website to play against a computer, solve puzzles, and view leaderboard. Built with React, Chess.js, Firebase, Chess.com API
https://github.com/indiecodermm/chess-arena

chessjs react-chessboard reactjs

Last synced: 8 days ago
JSON representation

Chess website to play against a computer, solve puzzles, and view leaderboard. Built with React, Chess.js, Firebase, Chess.com API

Awesome Lists containing this project

README

        

[![last commit](https://custom-icon-badges.demolab.com/github/last-commit/indiecodermm/chess-arena?logo=history&logoColor=white&label=Update&color=%23673ab7)](https://github.com/IndieCoderMM/chess-arena/commits/)
[![Stars](https://custom-icon-badges.demolab.com/github/stars/IndieCoderMM/chess-arena?logo=star&label=Stars)](https://github.com/IndieCoderMM/chess-arena/stargazers)

## πŸ“‘ Table of Contents
- [β™Ÿ Chess Arena](#-chess-arena)
- [πŸ”₯ Key Features](#-key-features)
- [πŸ‘¨β€πŸ’» Built With](#-built-with)
- [🧰 Tech Stack](#-tech-stack)
- [βš™ Implementation](#-implementation)
- [πŸš€ Live Demo](#-live-demo)
- [🎯 Todos](#-todos)
- [πŸ’» Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Deployment](#deployment)
- [πŸ“§ Contact](#-contact)
- [🀝 Contributing](#-contributing)
- [πŸ’– Show your support](#-show-your-support)
- [πŸ’Ž Useful Resources](#-useful-resources)
- [πŸ“ License](#-license)

# β™Ÿ Chess Arena

**πŸ‘·β€β™‚οΈStill under development**

A chess website that allows users to play chess online with other players, solve puzzles and view leaderboard.

![Screenshot](app_screenshot.png)

(back to top)

## πŸ”₯ Key Features

- Play chess with a computer opponent
- Solve daily chess puzzles
- View top players

(back to top)

## πŸ‘¨β€πŸ’» Built With

### 🧰 Tech Stack
- React
- Redux
- Bootstrap
- Firebase

(back to top)

### βš™ Implementation
- Chessboard created with *react-chessboard*
- Move validation using *chess.js*
- Access puzzles and leaderboards through Chess.com API
- User authentication provided by *Firebase*

(back to top)

## πŸš€ Live Demo

You can visit the [MVP version of this website here](https://chess-arena.onrender.com).

(back to top)

## 🎯 Todos

- [ ] Match history
- [ ] Puzzle leaderboard
- [ ] Two-player mode
- [ ] Time control
- [ ] Profile data

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

In order to run this project you need [Node.js](https://nodejs.org/en/) installed on your machine.

### Setup

Clone this repository to your desired folder:

```sh
cd my-project
git clone [email protected]:IndieCoderMM/chess-arena.git .
```

### Install

Install the dependencies with:

```sh
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm start
```

### Deployment

You can deploy this project using:

```sh
npm run build
```
This will create a production-ready build of your website in `build/` folder, which you can use to deploy on a static site hosting platform.

(back to top)

## πŸ“§ Contact

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

[![Github](https://img.shields.io/badge/GitHub-673AB7?style=for-the-badge&logo=github&logoColor=white)](https://github.com/IndieCoderMM)
[![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/hthantoo)
[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:[email protected])

(back to top)

## 🀝 Contributing

I welcome any and all contributions to my website! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

Feel free to check the [issues page](../../issues/).

(back to top)

## πŸ’– Show your support

If you like this project, please consider giving it a ⭐.

(back to top)

## πŸ’Ž Useful Resources
-

(back to top)

## πŸ“ License

This project is [MIT](./LICENSE) licensed.

(back to top)