saiyn / codenames

👾 Realtime Codenames game that you can play on your phone, TV, or laptop

Codenames

Realtime browser-based implementation of the classic social word game, Codenames, designed to be played on multiple devices, or using a shared screen and mobile phones.

Try it out!

Blog Series

To read more about how this project came to fruition and how to build an app using the same technologies, follow the links below!

• Part 1 - Introduction and Planning
• Part 2 - Enabling Websockets in Flask using Flask-SocketIO
• Part 3 - Scaffolding a Vue App with vue-cli and Managing State with Vuex
• Part 4 - Integrating Websockets into a Real-Time Vue App with Socket.io and Vuex

Rules

Rules for codenames can be found here.

Development

The app uses flask as its back-end and webpack as a front-end dev server.

Prerequesites

• Docker
• Docker Compose

Run in Development

./run.sh development
# or run the docker-compose command manually
docker-compose -f docker-compose.yml -f docker-compose.development.yml up --build
# navigate to localhost:8080 in browser

Production

./run.sh production