Categorygithub.com/fabricemrchl/codenames
modulepackage
0.0.0-20230429124109-b9209861eacb
Repository: https://github.com/fabricemrchl/codenames.git
Documentation: pkg.go.dev

# README

codenames

GoDoc

Codenames implements a web app for generating and displaying boards for the Codenames board game. Generated boards are shareable and will update as words are revealed. The board can be viewed either as a spymaster or an ordinary player.

A hosted version of the app is available at www.horsepaste.com.

Spymaster view of board

Building

The app requires a Go toolchain, node.js and parcel to build. Once you have those setup, build the application Go binary with:

go install github.com/jbowens/codenames/cmd/codenames

Then from the frontend directory, install the node modules:

npm install

and start the app (listens to changes)

npm start

or build the app

npm run build

Docker

Alternatively, the repository includes a Dockerfile for building a docker image of this app.

docker build . -t codenames:latest

The following command will launch the docker image:

docker run --name codenames_server --rm -p 9091:9091 -d codenames

The following command will kill the docker instance:

docker stop codenames_server

# Packages

No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GameState encapsulates enough data to reconstruct a Game's state.
PebbleStore wraps a *pebble.DB with an implementation of the Store interface, persisting games under a []byte(`/games/`) key prefix.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author

# Type aliases

No description provided by the author