Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.48 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.48 KB
Raw

Go Variants

A place to play Go variants, brought to you by the OGF community.

Set up

Install and run the database

Follow these instructions to install MongoDB Community Edition and start mongod

Install and run the app

In the root of this repo, run

yarn install

This will install dependencies in the three main subdirectories in packages/: client/, server/ and shared/.

To run the app, you can run

yarn run build
yarn start

This will start two dev servers. One is a React server listening on localhost:3000, and the other is an Express server listening on localhost:3001.

Variant Demos

See #249 for information about variant demos, can also be used to develop variants without setting up MongoDB.

Creating a new variant

This PR has a simple example showing how to add tic-tac-toe to the repo: #27

There are two main files to be concerned with: shared/tictactoe/TicTacToe.ts and client/tictactoe/TicTacToeView.ts. The former specifies the rules of the game while the latter specifies how to render it on the client.

Disclaimer: the structure of the repo is changing rapidly, so the above PR may be outdated. Feel free to reach out in the forums thread if you need help creating a variant.