chess

Setup nodemon and pre-commit hooks

1. Install yarn or npm
2. Clone this repo, git clone https://github.com/zachsirotto/chess.git
3. Run yarn install or npm install

Install python

If you do not have >= Python 3.9.x, install pyenv with the easy-installer, then install a Python version >= 3.9.x.

Install dependencies

Use either pip or pipenv to install dependencies from setup.py from within the cloned repository. i.e. cd chess

Pipenv (recommended)

Run pipenv install -e . to install dependencies using pipenv within a virtualenv.

Pip (less recommended)

Run pip install . to install dependencies to your global pip package list.

Run and watch for file changes

nodemon --exec pipenv run python __init__.py

Run without watching for file changes

pipenv run python __init__.py

Future plans

• Move Analysis
• Neural Network: https://github.com/CSSLab/maia-chess

Contribution guidelines

This repository follows conventional commits, meaning commit messages should be structured as follows:

<type>(optional scope): <description>

Commit Types

Type	Emoji	Markdown
feat	✨	:sparkles:
fix	🐛	:bug:
docs	📚	:books:
style	💎	:gem:
refactor	🔨	:hammer:
perf	🚀	:rocket:
test	🚨	:rotating_light:
build	📦	:package:
ci	👷	:construction_worker:
chore	🔧	:wrench:

To add emojis automatically to commit messages, setup the pre-commit hook for this repo in order to run commit messages through devmoji: