Ecosyste.ms: Awesome

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

https://github.com/willb335/chessboardjsx

:black_square_button: Chessboard built for React
https://github.com/willb335/chessboardjsx

chess chessboard react

Last synced: about 1 month ago
JSON representation

:black_square_button: Chessboard built for React

Lists

README 

        
# UNMAINTAINED






lucena position

Carlsen 2016 Championship

sicilian defense



**A chessboard for React inspired by [chessboard.js](https://github.com/oakmac/chessboardjs)**



[![Build Status][build-badge]][build]

[![Code Coverage][coverage-badge]][coverage]

[![PRs Welcome][prs-badge]][prs]

[![version][version-badge]][package]

[![MIT License][license-badge]][license]

[![Commitizen friendly][commitzen-badge]][commitzen]

[![semantic-release][semantic-release-badge]][semantic-release]






## Installation



This module is distributed via [npm][npm] which is bundled with [node][node] and

should be installed as one of your project's `dependencies`:



```

npm install --save chessboardjsx

```



The package also depends on [React](https://reactjs.org/). Make sure you have that installed as well.



## Usage



* [Props](https://www.chessboardjsx.com/props): get started with Chessboard.jsx

* [With move validation](https://www.chessboardjsx.com/integrations/move-validation): how to integrate [chess.js](https://github.com/jhlywa/chess.js)

* [Integrating with chess engines](https://www.chessboardjsx.com/integrations/stockfish): how to integrate with Stockfish, the ~~world's strongest~~ [world's second strongest](https://www.chess.com/news/view/google-s-alphazero-destroys-stockfish-in-100-game-match) chess engine

* [Custom](https://www.chessboardjsx.com/custom): customize the board and pieces



## Contributing



Please take a look at CONTRIBUTING.md to find out how to contribute.



## What is Chessboard.jsx?



Chessboard.jsx is a React component with a flexible "just a board" API modeled from [chessboard.js](https://github.com/oakmac/chessboardjs). It's compatible with touch as well as standard HTML5 drag and drop.



## What can Chessboard.jsx **not** do?



The scope of Chessboard.jsx is limited to "just a board." This is intentional and

makes Chessboard.jsx flexible for handling a multitude of chess-related problems.



Specifically, Chessboard.jsx does not understand anything about how the game of

chess is played: how a knight moves, who's turn is it, is White in check?, etc.



Fortunately, the powerful [chess.js](https://github.com/jhlywa/chess.js) library deals with exactly this sort of

problem domain and plays nicely with Chessboard.jsx's flexible API.



Here is a list of things that Chessboard.jsx is **not**:



* A chess engine

* A legal move validator

* A PGN parser



Chessboard.jsx is designed to work well with any of those software components, but the idea

behind the library is that the logic that controls the board should be

independent of those other domains.



## Contributors



Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):



This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!



| [
Will](https://github.com/willb335)
[💻](https://github.com/willb335/chessboardjsx/commits?author=willb335 "Code") [📖](https://github.com/willb335/chessboardjsx/commits?author=willb335 "Documentation") [💡](#example-willb335 "Examples") [⚠️](https://github.com/willb335/chessboardjsx/commits?author=willb335 "Tests") | [
Andrew Bashelor](https://github.com/a-bash)
[📖](https://github.com/willb335/chessboardjsx/commits?author=a-bash "Documentation") | [
yougotgotyo](https://chadburg.com/)
[🤔](#ideas-yougotgotyo "Ideas, Planning, & Feedback") | [
Roger Knapp](http://csharptest.net)
[🤔](#ideas-csharptest "Ideas, Planning, & Feedback") | [
Tiago Serafim](https://github.com/slig)
[💻](https://github.com/willb335/chessboardjsx/commits?author=slig "Code") [📖](https://github.com/willb335/chessboardjsx/commits?author=slig "Documentation") | [
Kef Schecter](http://www.furrykef.com/)
[🐛](https://github.com/willb335/chessboardjsx/issues?q=author%3Afurrykef "Bug reports") | [
Nils-Helge Garli Hegvik](http://www.lånekalkulatoren.no)
[💻](https://github.com/willb335/chessboardjsx/commits?author=nilsga "Code") |

| :---: | :---: | :---: | :---: | :---: | :---: | :---: |

| [
Levi Durfee](https://levi.lol/)
[💻](https://github.com/willb335/chessboardjsx/commits?author=levidurfee "Code") [📖](https://github.com/willb335/chessboardjsx/commits?author=levidurfee "Documentation") | [
Chris](https://github.com/altruisticsoftware)
[💻](https://github.com/willb335/chessboardjsx/commits?author=altruisticsoftware "Code") | [
Harrison Kerr](https://hwkerr.github.io/)
[💻](https://github.com/willb335/chessboardjsx/commits?author=hwkerr "Code") |



## LICENSE



MIT



[npm]: https://www.npmjs.com/

[node]: https://nodejs.org

[build-badge]: https://img.shields.io/travis/willb335/chessboardjsx.svg?style=flat-square

[build]: https://travis-ci.org/willb335/chessboardjsx

[coverage-badge]: https://img.shields.io/codecov/c/github/willb335/chessboardjsx.svg?style=flat-square

[coverage]: https://codecov.io/github/willb335/chessboardjsx

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

[prs]: http://makeapullrequest.com

[version-badge]: https://img.shields.io/npm/v/chessboardjsx.svg?style=flat-square

[package]: https://www.npmjs.com/package/chessboardjsx

[license-badge]: https://img.shields.io/npm/l/chessboardjsx.svg?style=flat-square

[license]: https://github.com/willb335/chessboardjsx/blob/master/LICENSE

[commitzen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[commitzen]: http://commitizen.github.io/cz-cli/

[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

[semantic-release]: https://github.com/semantic-release/semantic-release