https://github.com/hudy9x/keyreader

Open source keystroke application for Windows that inspired by Keycast
https://github.com/hudy9x/keyreader

desktopapp reactjs rust tauri

Last synced: 3 months ago
JSON representation

Open source keystroke application for Windows that inspired by Keycast

• Host: GitHub
• URL: https://github.com/hudy9x/keyreader
• Owner: hudy9x
• Created: 2023-04-15T18:49:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T12:57:53.000Z (9 months ago)
• Last Synced: 2024-05-16T14:00:10.831Z (9 months ago)
• Topics: desktopapp, reactjs, rust, tauri
• Language: TypeScript
• Homepage: https://hudy9x.github.io/keyreader/
• Size: 8.11 MB
• Stars: 22
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Introduction

KeyReader - an open source keystroke visualizer that inspired from KeyCastr

Watch how i built it on youtube: https://www.youtube.com/watch?v=hhwjGIICLuA&t=27s

![image-1](./docs/screenshoot.png)

KeyReader enables you to share your keystroke when streaming your screen. And yes, it looks like KetCastr. 

The only difference is that it supports **Windows**. 

For now, it only provide one theme as the above image

## Demo

Visit [homepage](https://hudy9x.github.io/keyreader/)

Enable to visualize typing

![image-2](./docs/typing.gif)

KeyReader allows you to moving around as well

![image-3](./docs/moving.gif)

# Installation

### For Windows 

Download the latest version from [here](https://github.com/hudy9x/keyreader/releases)

Or, install using [scoop](https://scoop.sh/)

```shell

$ scoop bucket add my-bucket https://github.com/hudy9x/scoop-buckets

$ scoop install keyreader

```

### For Linux

For now, follow Development guide to build your own.

### For Mac

Please use [KeyCastr](https://github.com/keycastr/keycastr) instead

# Upgrade 

### For Windows

If you already have KeyReader on your PC and you want to upgrade it's version

Follow the guide

```shell

$ scoop update

$ scoop update keyreader

```

Or, just download the latest version and re-install it

# Development

KeyReader built on [Tauri](https://tauri.app/). So, please follow their [instruction](https://tauri.app/v1/guides/getting-started/prerequisites) for installing development environment

Second, you must have `nodejs`, `npm` or `yarn`

After installing all above dev tools. Open terminal and start developing

```shell

$ npm run devapp

```

For building

```shell

$ npm run tauri build

```

# Issues

Please visit [issues](https://github.com/hudy9x/keyreader/issues)

Feel free to fork and make a PR for me

Note: I'm a new to Rust, so please help me improve the source code. Big thanks for good explanation, i'd love to learn from you guys

# License

[BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)

KeyCastr has been freely available for the Windows since 2023.