sparr / freeboardgames.org

FOSS platform for publishing boardgame.io games

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 hundreds of players.

Play now at FreeBoardGames.org

Games

• ✔️ Chess
• ✔️ TakeSix! (by JosefKuchar, similar to 6 Nimt)
• ✔️ Nine Mens Morris (by JosefKuchar)
• ✔️ Reversi (by JosefKuchar, similar to Rollit and Othelo)
• ✔️ Seabattle (similar to Battleship).
• ✔️ Cornerus (by JosefKuchar, similar to Blokus)
• ✔️ TicTacToe.
• ✔️ Checkers

Check the game development kanban

Features

• ✔️ Code splitting.
• ✔️ Server side rendering.
• ✔️ Installable.
• ✔️ Loads fast - small javascript sizes.
• ✔️ Works offline.
• 🚧 Party/lobby system.
• 🚧 i18n.

Check out the infrastructure kanban.

Contributing

Contributions are always welcome, even if just reporting bugs (check the known bugs kanban). Feel free to ask for any help!

Community

Running locally

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

yarn install

yarn run dev

Important Commands:

yarn run dev builds and starts the development web server.

yarn run prod builds and starts the production web server.

yarn run bgio builds and starts the Boardgame.io server (used for multiplayer games).

yarn run bgio:dev builds and starts the boardgame.io server. The boardgame.io server will automatically recompile/restart on file changes.

yarn run pre runs all tests, including linting/formatting, unit tests, and e2e/visual tests. This command is run by Travis CI for all pull requests.

yarn run autopre will automatically format and attempt to fix issues. Then it will run the same tests as pre (mentioned above). You should run this command before committing changes.

yarn run e2e:buildandstartserver will build and start an unoptimized production-like web server for e2e tests.

yarn run cyp:run will run e2e visual testing.

yarn run test will run all unit tests. You may use Jest CLI options (such as --watch).

Jest CLI Options: https://jestjs.io/docs/en/cli.html