Skip to content

IvanDimanov/biscuit-machine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Biscuit Machine

Online game where user bakes biscuits.

App

Videos

Running locally

git clone [email protected]:IvanDimanov/biscuit-machine.git
cd biscuit-machine
yarn
yarn start

Tests

Running unit tests:

yarn test

Generate unit test coverage:

yarn test-coverage

Then you can open ./src/coverage/index.html.

Running E2E tests:

yarn test-e2e

Access Storybook components here.

Tech stack

File & Folder structure

Here we describe what you can find and where.

/src
  /App
    -- Root folder where we add Internationalization, check ENV VARs,
    -- implement Suspense fallback and base CSS rules

  /components
    -- All UI blocks that can be reused in multiple machine parts
    -- It is generally desirable to keep balance between reusable components and "props dripping"

  /globalState
    -- Every piece of shared data has its own hook
    -- Every hook exposes selectors for data and action manipulation

  /Machine
    -- Main instants where all game machine parts are combined and synched

  /stories
    -- Storybook placeholder hosting main project info

  /utils
    -- Common set of handy functions that manage random numbers, rescaling, etc.

Used resources

During the development of this game a number of public images, color schemes, sounds, and animations were used. Here`s a list of their domains.

Used images

Used colors

Used sounds

Sound Editing

CSS Animations