Skip to content

2208-Capstone-Team-2/codenames

Repository files navigation

Codenames

logo

Play popular card game Codenames with your friends online today!

Fast-paced and easy to learn, simply click the 'create room' button, and invite your friends by sending them the URL in your web browser. Everyone should now enter their usernames, assign themselves teams and roles. The host can now setup the game board- and you're ready to play CODENAMES!

Watch our presentation and recorded demo video!

Getting Started

There are two ways to run our project.

Play online

Visit our website and play!

Play locally

  1. Clone this repo onto your computer
  2. If you don't have it already, install Postgresql
  3. Open terminal, change directory into the cloned repo's root folder, and and enter each line individually:
createdb codenames
npm install
npm run seed:dev
npm run start:dev
  1. Navigate to http://localhost:3000/ and create a room!
  2. For additional players, you will need to have a unique browser visit this port. This can be achieved by creating an incognito tab!

Diagrams and Images from planning

Our backend models & schema:

A diagram showing all the models, and their associations A diagram of how players are created and updated, depending on if they created the room or entered it via a link: Flow of how players are created and updated, depending on if they created the room or entered it via a link.

Known Issues

  • A player who disconnects mid-game cannot rejoin. They are locked out until the game resets.
  • Idling in a room for an indeterminate amount of time may kick you from the room.
  • The Timer feature was not completed
  • If the host role is claimed while a board is active, the setup game menu appears behind the board. In this case, please reset the whole game inorder to access this menu.
  • Cards are not tabbable, which is essential for accessibility to those without mouse controls.

Contributing

Thank you for being interested in contributing to our project. Currently we are not looking for contributions from users outside of our organization.

Acknowledgements

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages