Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kael89/kill-the-king
Front-end of Kill the King, a web app that calculates forced checkmates in a chess position
https://github.com/kael89/kill-the-king
checkmate chess
Last synced: 19 days ago
JSON representation
Front-end of Kill the King, a web app that calculates forced checkmates in a chess position
- Host: GitHub
- URL: https://github.com/kael89/kill-the-king
- Owner: kael89
- License: gpl-3.0
- Created: 2019-04-16T00:57:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-05T11:17:12.000Z (over 2 years ago)
- Last Synced: 2024-11-08T14:47:52.348Z (2 months ago)
- Topics: checkmate, chess
- Language: JavaScript
- Homepage: https://killtheking.netlify.app/
- Size: 961 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kill the King
A web app that calculates forced checkmates in a given chess position
🌐 https://killtheking.netlify.app
Uses the [checkmate-finder](https://github.com/kael89/checkmate-finder) API
## Features
- Available Moves viewer
- Move History
- Board import/export
- Light/Dark themes
## Installation
### Run the app locally
1. Add a `.env` file under the project's directory (see `.env.example`). `REACT_APP_API_URL` should be the base url under which our back-end APIs are served
2.
```
npm install
npm run start
```
The application should now be running at http://localhost:3000
## Project structure
```
kill-the-king
├── cypress https://www.cypress.io end-to-end tests
│ ├── fixtures
│ ├── integration Test home folder
│ ├── plugins
│ ├── support Custom commands and helper methods
├── public
├── src
│ ├── components React components
│ ├── constants
│ ├── enums
│ ├── images
│ ├── store Redux store
│ ├── themes
│ └── utilities
│ ├── api.js Back-end API
│ ├── propTypes.js Shared propTypes
│ ├── typedef.js jsDoc type definitions
```
## Built with
- [ES6](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [React.js](https://reactjs.org/)
- [Redux.js](https://redux.js.org/)
- [Create React App](https://github.com/facebook/create-react-app)
- [Babel](https://babeljs.io/)
- [ESLint](https://eslint.org/)
- [Prettier](https://github.com/prettier/prettier)
- [Material UI](https://material-ui.com/)
- [Cypress](https://www.cypress.io/)
- [Jest](https://jestjs.io/)
## Acknowledgments
- Kudos to [Sam Herbert](https://github.com/SamHerbert/SVG-Loaders) for creating the loading spinner used in this project!
## Authors
**Kostas Karvounis** - [kael89](https://github.com/kael89)
## License
This project is licensed under the GNU General Public License v3.0