walk-up-alarm/README.md

# Walk-up alarm

![GitHub pages deploy](https://github.com/nzambello/walk-up-alarm/workflows/Test%20and%20deploy/badge.svg?branch=main)

Alarm clock ringing until you walk out of the bed.

<p>
  See it in action:
  <a href="https://nzambello.github.io/walk-up-alarm/" target="_blank" rel="noopener noreferrer">
    nzambello.github.io/walk-up-alarm
  </a>
</p>
<p>It's a <a href="https://en.wikipedia.org/wiki/Progressive_web_application" target="_blank" rel="noopener noreferrer">PWA</a>. Install it on your device!</p>
<br />
<a href="https://nzambello.github.io/walk-up-alarm/" target="_blank" rel="noopener noreferrer">
  <img src="./public/walk-up-alarm.svg" width="200" alt="Walk-up logo" />
</a>
<br />

## Screenshots

<p float="left">
  <img src="./screenshots/start.png" title="Start page" height="450" />
  <img src="./screenshots/clock-alarm-set.png" title="Alarm set, show clock" height="450" />
  <img src="./screenshots/alarm-playing.png" title="Alarm playing" height="450" />
</p>
<br />

## Development

```bash
yarn install
```

### Run the app

```bash
yarn dev
```

### Build the app

```bash
yarn build
yarn preview
```

### Run tests

```bash
yarn test
```

## Contributions

Please follow our [convention](COMMITLINT.md) on commits format.