Thynkon/chess-frontend

ExChess - Frontend

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Configuration
   • Installation
3. Documentation
4. License

Built With

• TypeScript
• React
• React Framer Motion
• AnimeJS
• Formik
• Tailwind CSS
• Flow bite
• React Chessground
• React Router

(back to top)

Getting Started

This project was inspired by both Lichess and Chess.com.

It uses Lichess chessground library to display the chessboard and move pieces.

The business logic is handled by the backend.

Prerequisites

• Yarn

Configuration

As this application connects to a Elixir backend, you need to specify the API Endpoint.

To do so, rename the file src/config.ts.example to src/config.ts and change the URL.

Installation

1. Install dependencies

   yarn install

2. Launch the web server

   yarn run start

(back to top)

Documentation

A detailed description of this project can be found under docs/report.md.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to 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

(back to top)

License

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

(back to top)

Contact

• Thynkon

(back to top)