Note: It is assumed that you already have
yarninstalled on your computer. This project uses features available inyarnthat are not supported innpm, so if you need it, please install it.
- Clone the repo
- Run
yarn installin the project root
Run yarn start in the project root to start both the server and client.
yarn start can also be run in either package individually, to run just that part of the project.
The repository contains both the API server, written with GraphQL, and the Client, written in ???; they can be found in the packages/server and packages/client directories respectively.
These packages are managed by lerna, a tool that helps packages within a single repository depend on each other. It also provides helpful commands for running commands within each package from the top level. Additionally, this project leverages yarn workspaces to make managing dependencies through lerna easier.
The server is a Node.js application leveraging apollo-server to implement a GraphQL interface to the game. It is written in TypeScript in order to benefit from the better development experience and increased productivity of working with well-defined types.
Run yarn test in either package, or in the project root, to run the tests.