Meticulous UI

1. Start up

Install Dependencies

npm install

Note: you will need to have installed NodeJS v18 or later

Run dev mode

npm run start

2. Code conventions

We are using Commitizen and Commitlint to provide meaningful commits

Formatter

We are using Prettier to keep code in a standard way.

# Format the files exists
$ npm run format

Make a commit

When you are ready to commit, run

$ npm run commit

We use the follow structure

type(scope): subject

3. How Dial Works

Gestures

Dial has only 3 actions that we can catch from it. Turn Left, Turn Right and Click.

Conventions

Horizontal screens

Vertical screens

Circular screens

Keyboard screen

Behaviour

Based on the gesture, we need to use them into each state in a specific way. For instance, when the state is showing barometer, we have the three gestures available. On the other hand, when state is showing scale, we just have available the gesture double tare.

Note: double tare gesture comes from an extra hardware element.

4. Events

We react to different button events coming from controller. We have mapped every button to a keyboard event for testing. See SocketProviderValue.ts.