README.md

Kill the King

A web app that calculates forced checkmates in a given chess position

🌐 https://killtheking.netlify.app

Uses the 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

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
• React.js
• Redux.js
• Create React App
• Babel
• ESLint
• Prettier
• Material UI
• Cypress
• Jest

Acknowledgments

• Kudos to Sam Herbert for creating the loading spinner used in this project!

Authors

Kostas Karvounis - kael89

License

This project is licensed under the GNU General Public License v3.0