A Biscuit Machine implementation. Yummy!
Go to file
Stanislav Nikolov 852f748633 Initial commit 2022-08-21 17:03:59 +03:00
.vscode Initial commit 2022-08-21 17:03:59 +03:00
public Initial commit 2022-08-21 17:03:59 +03:00
src Initial commit 2022-08-21 17:03:59 +03:00
src-ssr Initial commit 2022-08-21 17:03:59 +03:00
test/vitest Initial commit 2022-08-21 17:03:59 +03:00
.editorconfig Initial commit 2022-08-21 17:03:59 +03:00
.eslintignore Initial commit 2022-08-21 17:03:59 +03:00
.eslintrc.js Initial commit 2022-08-21 17:03:59 +03:00
.gitignore Initial commit 2022-08-21 17:03:59 +03:00
.nycrc Initial commit 2022-08-21 17:03:59 +03:00
.prettierrc Initial commit 2022-08-21 17:03:59 +03:00
README.md Initial commit 2022-08-21 17:03:59 +03:00
index.html Initial commit 2022-08-21 17:03:59 +03:00
package.json Initial commit 2022-08-21 17:03:59 +03:00
postcss.config.js Initial commit 2022-08-21 17:03:59 +03:00
quasar.config.js Initial commit 2022-08-21 17:03:59 +03:00
quasar.extensions.json Initial commit 2022-08-21 17:03:59 +03:00
quasar.testing.json Initial commit 2022-08-21 17:03:59 +03:00
tsconfig.json Initial commit 2022-08-21 17:03:59 +03:00
vitest.config.ts Initial commit 2022-08-21 17:03:59 +03:00
yarn.lock Initial commit 2022-08-21 17:03:59 +03:00

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 visualization of the system has been provided, which allows users to interact with the machine and monitor its operation. Its implementation can be found in the src/components directory.

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.