Skip to content

freeboardgames/FreeBoardGames.org

Repository files navigation

FreeBoardGames.org

FOSS platform for publishing your boardgame.io games. We curate high quality implementations of board games and optimize your game for delivery so you can quickly reach thousands of players.

Play now at FreeBoardGames.org

Contributing

Check out our documentation and how to add your game.

Contributions are always welcome, even if just reporting bugs (check our issue tracker). Feel free to ask for any help!

Community

Discord Logo

Running locally

git clone https://github.com/freeboardgames/FreeBoardGames.org
cd FreeBoardGames.org

yarn install  # installs dependencies

yarn run dev  # runs the webserver and backend (for online multiplayer games)

Important commands

yarn run dev GAME runs the development environment only for a given game.

yarn run test GAME runs unit tests and linter for given game.

yarn run lint GAME runs linter for given game.

yarn run fix GAME tries to automatically fix linter errors for given game.

yarn run ci on root runs everything CI will run (including e2e tests).

Omitting the GAME from any command above will run it for all the codebase.

Thanks to

Our amazing contributors

Sponsors