https://github.com/peterpme/codenames-deluxe
Codenames Deluxe: Play Codenames online with your friends & family across every device!
https://github.com/peterpme/codenames-deluxe
Last synced: 2 months ago
JSON representation
Codenames Deluxe: Play Codenames online with your friends & family across every device!
- Host: GitHub
- URL: https://github.com/peterpme/codenames-deluxe
- Owner: peterpme
- Created: 2020-04-18T03:03:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T19:32:03.000Z (over 2 years ago)
- Last Synced: 2025-03-01T08:11:25.377Z (3 months ago)
- Language: CSS
- Homepage:
- Size: 4.66 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codenames Deluxe 🎮
A showcase & experiment using some :fire: tools :smile:
- [ReasonReact](https://github.com/reasonml/reason-react/)
- [Create React App](https://create-react-app.dev)
- [Tailwind CSS](https://tailwindcss.com/)
- [GenType](https://github.com/cristiano/gen-type)
- [Socket.io](https://socket.io/)
- [Fly](https://fly.io)
- [Redis](https://redis.io/)
Using these tools we're able to create a infinitely scalable, globally available, every platform playable, game!
## What is Codenames?
Codenames is a 2015 card game for 4–8 players designed by Vlaada Chvátil and published by Czech Games Edition. Two teams compete by each having a "spymaster" give one-word clues that can point to multiple words on the board. The other players on the team attempt to guess their team's words while avoiding the words of the other team. In a variant with 2–3 players, one spymaster gives clues to the other player or players. Read more [here](https://en.wikipedia.org/wiki/Codenames_(board_game))
## Project Structure
### Client
Runs both create-react-app (`yarn start`) and the ReasonML compiler (`yarn re:watch`) which means you'll need two terminal windows
The client has a flat file structure so the file names should be reasonably easy to reason about (puns!!)
The file that might throw you off is `T.re` which is treated like your types / data structure file. It's a pattern that's been copied from the OCaml world. The filename doesn't mean anything, it just shorthand for `Type`.
### Server
Same idea. Two terminal windows:
Inside the `client` folder, install the dependencies `yarn` and then `yarn start` to start the server.
In another terminal window, run: `yarn re:watch` to start the reason compiler
### Contributing
Help make this project better :fire: All contributions are welcome!