https://github.com/cupcakearmy/unpixel

Utility app for helping with the 20/20/20 rule for alleviating CVS induced stress.
https://github.com/cupcakearmy/unpixel

20-20-20 app computer-vision-syndrome cvs utility

Last synced: 3 months ago
JSON representation

Utility app for helping with the 20/20/20 rule for alleviating CVS induced stress.

• Host: GitHub
• URL: https://github.com/cupcakearmy/unpixel
• Owner: cupcakearmy
• License: mit
• Created: 2021-04-06T13:02:26.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-21T15:55:47.000Z (about 3 years ago)
• Last Synced: 2024-10-05T02:36:48.410Z (4 months ago)
• Topics: 20-20-20, app, computer-vision-syndrome, cvs, utility
• Language: TypeScript
• Homepage:
• Size: 2.22 MB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![logo](./build/github.jpg)

# UnPixel

Help your eyes take a break

![screenshot](./build/screenshot.png)

## 🤔 Why?

When staring for long times at computer screen our eyes can get dry and suffer form what is called Computer Vision Syndrome (CVS).

To combat and alleviate the symptoms there is the famous 20/20/20 rule that aims at reducing the stress on our eyes caused by focusing for long periods on the same distance.

This is not medical advice. Read more [here](https://en.wikipedia.org/wiki/Computer_vision_syndrome) and [here](https://www.aoa.org/healthy-eyes/eye-and-vision-conditions/computer-vision-syndrome).

## 💻 Installation

Head to the [release page](https://github.com/cupcakearmy/unpixel/releases) and grab the latest for your platform.

- For `macOS` you can downlaod the `.dmg` image.

- For `Windows` download the `.exe`.

- For `Linux` either the `.AppImage` or `.deb`, you will know what fits you 😉.

## 🛠 Building / Development

1. Clone the repo

2. `pnpm install`

3. `pnpm dist` to build for all platforms

Alternatively you can run `pnpm build` and the `pnpm electron-builder -m` for `macOS`, `-l` fir `linux` or `-w` for `windows`.

## 📦 Release

1. Bump version in `package.json`

2. Update `CHANGELOG.md`

3. Create a draft release with the new version. (e.g. tag with `v1.2.3`).

4. Start the publish action and the ci will build and upload assets to the draft matching the version of `package.json` and draft.