https://github.com/jbowens/codenames

Play codenames online
https://github.com/jbowens/codenames

board-game codenames

Last synced: about 2 months ago
JSON representation

Play codenames online

• Host: GitHub
• URL: https://github.com/jbowens/codenames
• Owner: jbowens
• Created: 2016-01-31T05:15:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:36:41.000Z (about 1 year ago)
• Last Synced: 2024-06-20T16:34:21.168Z (3 months ago)
• Topics: board-game, codenames
• Language: Go
• Homepage: https://www.horsepaste.com
• Size: 1.99 MB
• Stars: 618
• Watchers: 13
• Forks: 208
• Open Issues: 34
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - jbowens/codenames - Play codenames online (Go)

README

        
# codenames

[![GoDoc](https://godoc.org/github.com/jbowens/codenames?status.svg)](https://godoc.org/github.com/jbowens/codenames)

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](https://www.horsepaste.com).

![Spymaster view of board](https://raw.githubusercontent.com/jbowens/codenames/master/screenshot.png)

## Building

The app requires a [Go](https://golang.org/) toolchain, node.js and [parcel](https://parceljs.org/) 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

```