Skip to content

A card matching game following classic Memory Game rules

Notifications You must be signed in to change notification settings

aaronmcadam/cat-match

Repository files navigation

CatMatch

A card matching game following classic Memory Game rules.

Deployed on Netlify

You can play the game here: https://pedantic-kirch-adceb8.netlify.app/

Game experience

You can see the overall user experience in the following screen capture: Game experience

Game logic statechart

The following XState statechart shows the game's logic: Game statechart

Jiji Design System

Jiji the cat

Named after the cat in Kiki's Delivery Service, Jiji is our design system.

This demonstrates how to build custom themes with Chakra UI, with the ability to implement our own components based on Chakra's.

Figma designs

The Figma designs are on the Figma Community here: https://www.figma.com/community/file/1040260142972521288/CatMatch

Storybooks

We use Storybook to develop and document our components.

Jiji

yarn storybook:jiji will start Jiji's Storybook app:

Jiji Storybook

Game

yarn storybook:game will start the game's Storybook app:

Game Storybook


Getting started

Starting the application server

Run yarn start to start up the server and view the application.

Working on the application

Start development by running yarn dev, which will start the dev server and Cypress.

We recommend using "Cypress Driven Development" to follow an outside-in TDD workflow.

Running tests

By default, yarn test will only run tests for the app. To run every test in the project, run yarn test:all.

Technologies

We use the following technologies: