Usage:

To import into an application targeting the web:

import { ... } from "goban";

To import into an application targeting node, use the goban-engine package:

import { ... } from "goban-engine";

Documentation

https://docs.online-go.com/goban/

Dev setup

1. Building goban

If you have make installed you can simply run

make

Or, you can build and run manually using

yarn install
yarn run dev

(yarn install is only necessary the first time you start working on the project, or whenever dependencies are updated)

2. Using local fork of goban while working on online-go.com

The online-go.com repo uses a goban submodule (in submodules/goban). To configure this to use your fork/branch, you can do the following from within your online-go.com repo clone root:

cd submodules/goban
git remote add myFork https://github.com/<your_username>/goban.git
git fetch myFork
git checkout -b <local_branch_name> myFork/<remote_branch_name>

Once done, your online-go.com development environment will use your goban fork's goban code.

To reset the submodule, run from online-go.com repo clone root:

git submodule update --force --checkout submodules/goban

Before PR

Be ready for CI check on PR:

• run tests npm test
• run prettify npm run prettier

[Optional] You can also set up a pre-commit to run checks locally before you commit:

npx husky install

Running & Writing tests

Tests live in src/__tests__ directory, check it out & add Your own! To run tests:

npm test