51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
|
# The Biscuit Machine
|
||
|
|
|
||
|
|
This repository contains a Biscuit Machine implementation, as defined in the [enclosed PDF](public/The_biscuit_machine_task.pdf). The implementation is based on the [Quasar framework](https://quasar.dev), and thereby supports various deployment targets. A published live SSR version is available on [https://biscuit-machine.snikolov.me](http://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
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn
|
||
|
|
# or
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
### Start the app in development mode (hot-code reloading, error reporting, etc.)
|
||
|
|
|
||
|
|
```bash
|
||
|
|
quasar dev
|
||
|
|
```
|
||
|
|
|
||
|
|
### Lint the files
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn lint
|
||
|
|
# or
|
||
|
|
npm run lint
|
||
|
|
```
|
||
|
|
|
||
|
|
### Format the files
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn format
|
||
|
|
# or
|
||
|
|
npm run format
|
||
|
|
```
|
||
|
|
|
||
|
|
### Build the app for production
|
||
|
|
|
||
|
|
```bash
|
||
|
|
quasar build
|
||
|
|
```
|
||
|
|
|
||
|
|
### Customize the configuration
|
||
|
|
|
||
|
|
See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js).
|