This game is best developed using the included Visual Studio Code DevContainer. This will ensure that all dependencies are installed and configured correctly.
Open the project in Visual Studio Code, and you should be prompted to open the project in a DevContainer- Don't do this right away if you haven't yet configured your .env for the devcontainer. Under .devcontainer, copy .env.example to .env and update the values to suit your needs. You can run npm run new:secret to generate a new database secret. You'll want to copy the other .env.example file under chili-and-cilantro-api with matching values. Once you have modified the environment configuration files, you can open the command palette and search for "Reopen in Container". (control+shift+p) You'll need access to auth0 in order to get the secrets necessary for the application .env file.
If you wish to change the database password later, you'll need to delete the mongo volume in Docker Desktop and restart the container.
Once you have reopened the project in the DevContainer, you'll have a running mongo instance available on localhost:27017 and your application will be able to use it. The DevContainer will automatically run yarn install for you and this will take a few minutes the first time you load the container. Once it is done you can run yarn build-serve:dev to build the shared library, react app, and run the node api server in development mode. The application will be available at localhost:3000.
See the root package.json for additional commands available to you. yarn serve:dev will just build and serve the node portion if the library and react apps are unchanged.
This project is an NX monorepo. The root package.json contains scripts for building and serving the shared library, react app, and node api server. The shared library, 'chili-and-cilantro-lib', is a collection of common types and functions that are used by both the react app and the node api server. The react app, 'chili-and-cilantro-react', is a standard create-react-app application. The node api server, 'chili-and-cilantro-api', is a standard express application.
In the root directory, there are sub-directories for the API, shared library, and react application. Additionally there are -e2e variants of the api and react application intended for end-to-end testing. These are not currently used.
The library has the mongoose schema and model definitions, as well as the typescript interfaces for the models. We have built a custom model framework underneath src/lib/models/BaseModel.ts and we have a custom schema class that references all of the models under src/schema.ts. The model descriptions, etc are in src/lib/schemaModelData.ts. If you add a new model, it must also be added to the ModelName enum in src/lib/enumerations/modelName.ts and src/lib/enumerations/modelNameCollection.ts which has the collection name. The model name is used to reference the model in the schema and the collection name is used to reference the collection in the database. BaseModel.getModel is then used to retrieve the model from the schema.
The interfaces are in the library so that we can reference the model interfaces from the front end to deal with retrieved documents, but the front end doesn't need to know about the schema, however it made sense to leave it all together in the library. In general we have tried to put everything in the library rather than leaving them in the API server or react application.
- A user creates a game. This user becomes the Master Chef. They must start the game and make other decisions. This is the LOBBY phase.
- Multiple users join the game- until MAX_CHEFS is reached- this number is 8 but it could easily be increased.
- The Master Chef at some point starts the game. The chef IDs up to that point are shuffled and a turn order is produced randomly. This is the SETUP phase. Starting the game is equivalent to starting the first round.
- Chefs take turns either placing a card or bidding. The minimum bid is 1, so the first Chef must place a card before anyone can consider bidding. The maximum bid is the total number of cards placed.
- Cards may be placed until everyone is out of cards or someone has bid.
- Once everyone is out of ingredient cards, the next player must bid.
- Once bidding begins, players can no longer place cards and must increase the bid or pass.
- Once all players have bid or passed, the person with the highest bid must reveal cards.
- Once all cards are placed or a player bids, the game moves to BIDDING phase.
- Whenever the bid is increased, all other players have the opportunity to increase it further or pass unless the bid is the maximum and we immediately move to the next phase.
- If the second player in the turn order increases the bid, we must go through the remainder of the players in the turn order and back through the first before moving to REVEAL phase.
- Once bidding is settled and we move to the REVEAL phase, the chef must turn over all of their own cards first, and may then select from other chef's ingredients in any order.