the-biscuit-machine/README.md

The Biscuit Machine

This repository contains a Biscuit Machine implementation, as defined in the enclosed PDF. The implementation is based on the Quasar framework, and thereby supports various deployment targets. A published live SSR version is available on https://biscuit-machine.snikolov.me.

Each component's logic is implemented as a composable function within src/composables. In particular, the main control system is in src/composables/biscuitMachine.ts.

Additionally, a visualisation of the system has been provided, which allows users to interact with the machine and monitor its operation.

Unit tests are available in the test/vitest/__tests__ directory and can be run with yarn test:unit:ci.

Install the dependencies

yarn
# or
npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

quasar dev

Lint the files

yarn lint
# or
npm run lint

Format the files

yarn format
# or
npm run format

Build the app for production

quasar build

Customize the configuration

See Configuring quasar.config.js.