Skip to content

Documentation ​

Docs for Play Cards, a platform for playing card games in real time with friends. For an overview of the project, see the README.

Technical ​

  • Getting started — prerequisites, running the app locally and other scripts
  • Architecture — how the browser, server and Redis fit together, auth and events
  • Testing strategy — the static checks and tests, what each covers and how to run it
  • Documentation — adding a doc, running the docs site and rebuilding diagrams

Games ​

  • Lobby — creating and joining a game, and what players and the host can do before it starts
  • Yaniv — the flow of a game, from dealing to scoring