{"id":20812848,"url":"https://github.com/hudy9x/keyreader","last_synced_at":"2025-05-07T11:03:10.317Z","repository":{"id":156778475,"uuid":"628375651","full_name":"hudy9x/keyreader","owner":"hudy9x","description":"Open source keystroke application for Windows that inspired by Keycast","archived":false,"fork":false,"pushed_at":"2024-05-16T12:57:53.000Z","size":8509,"stargazers_count":37,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T09:21:16.454Z","etag":null,"topics":["desktopapp","reactjs","rust","tauri"],"latest_commit_sha":null,"homepage":"https://hudy9x.github.io/keyreader/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hudy9x.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-15T18:49:54.000Z","updated_at":"2025-03-26T11:09:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"4c7608a1-d966-4ffd-8c02-53361d3116bb","html_url":"https://github.com/hudy9x/keyreader","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hudy9x%2Fkeyreader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hudy9x%2Fkeyreader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hudy9x%2Fkeyreader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hudy9x%2Fkeyreader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hudy9x","download_url":"https://codeload.github.com/hudy9x/keyreader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252865699,"owners_count":21816306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["desktopapp","reactjs","rust","tauri"],"created_at":"2024-11-17T20:59:40.104Z","updated_at":"2025-05-07T11:03:10.258Z","avatar_url":"https://github.com/hudy9x.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\r\n\r\nKeyReader - an open source keystroke visualizer that inspired from KeyCastr\r\n\r\nWatch how i built it on youtube: https://www.youtube.com/watch?v=hhwjGIICLuA\u0026t=27s\r\n\r\n\r\n![image-1](./docs/screenshoot.png)\r\n\r\nKeyReader enables you to share your keystroke when streaming your screen. And yes, it looks like KetCastr. \r\nThe only difference is that it supports **Windows**. \r\n\r\nFor now, it only provide one theme as the above image\r\n\r\n## Demo\r\nVisit [homepage](https://hudy9x.github.io/keyreader/)\r\n\r\nEnable to visualize typing\r\n\r\n![image-2](./docs/typing.gif)\r\n\r\n\r\nKeyReader allows you to moving around as well\r\n\r\n![image-3](./docs/moving.gif)\r\n\r\n# Installation\r\n### For Windows \r\nDownload the latest version from [here](https://github.com/hudy9x/keyreader/releases)\r\n\r\nOr, install using [scoop](https://scoop.sh/)\r\n```shell\r\n$ scoop bucket add my-bucket https://github.com/hudy9x/scoop-buckets\r\n$ scoop install keyreader\r\n```\r\n\r\n### For Linux\r\nFor now, follow Development guide to build your own.\r\n\r\n\r\n### For Mac\r\nPlease use [KeyCastr](https://github.com/keycastr/keycastr) instead\r\n\r\n# Upgrade \r\n### For Windows\r\nIf you already have KeyReader on your PC and you want to upgrade it's version\r\n\r\nFollow the guide\r\n\r\n```shell\r\n$ scoop update\r\n$ scoop update keyreader\r\n```\r\n\r\nOr, just download the latest version and re-install it\r\n\r\n# Development\r\nKeyReader built on [Tauri](https://tauri.app/). So, please follow their [instruction](https://tauri.app/v1/guides/getting-started/prerequisites) for installing development environment\r\n\r\nSecond, you must have `nodejs`, `npm` or `yarn`\r\n\r\nAfter installing all above dev tools. Open terminal and start developing\r\n\r\n```shell\r\n$ npm run devapp\r\n```\r\n\r\nFor building\r\n\r\n```shell\r\n$ npm run tauri build\r\n```\r\n\r\n# Issues\r\nPlease visit [issues](https://github.com/hudy9x/keyreader/issues)\r\nFeel free to fork and make a PR for me\r\n\r\nNote: 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\r\n\r\n# License\r\n[BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)\r\n\r\nKeyCastr has been freely available for the Windows since 2023.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhudy9x%2Fkeyreader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhudy9x%2Fkeyreader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhudy9x%2Fkeyreader/lists"}