Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zacharyl2/keyecho
Listen to Mechanical Keyboard Sounds with Every Keystroke - It's Fast
https://github.com/zacharyl2/keyecho
desktop keyboard keyboard-sounds rust tauri vue
Last synced: about 19 hours ago
JSON representation
Listen to Mechanical Keyboard Sounds with Every Keystroke - It's Fast
- Host: GitHub
- URL: https://github.com/zacharyl2/keyecho
- Owner: ZacharyL2
- License: agpl-3.0
- Created: 2024-05-31T11:47:31.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-31T11:06:11.000Z (2 months ago)
- Last Synced: 2025-01-04T04:05:00.096Z (about 19 hours ago)
- Topics: desktop, keyboard, keyboard-sounds, rust, tauri, vue
- Language: Rust
- Homepage:
- Size: 32.1 MB
- Stars: 664
- Watchers: 1
- Forks: 17
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# KeyEcho
> Listen to your keyboard typing and echo pleasant sounds
- ⚡️ Minimal CPU and memory usage, instant keystroke response
- 📦 Less than 5 MB in size, cross-platform compatibility
- 🛠️ Customizable sounds to suit your preferences
[More about its performance comparison and under the hood.](https://webdeveloper.beehiiv.com/p/opensourced-keyecho-fastresponsive-keyboard-sounds-every-keystroke-using-tauri)
## 🚀 Install
Supports Windows (64-bit/ARM64), macOS (Intel/Apple M1/M2), and Linux (64-bit/ARM64/ARMv7).
Visit the [release page](https://github.com/ZacharyL2/KeyEcho/releases) to download the appropriate installation package.
## 🎵 Custom Sounds
Want to create your own keyboard sounds? Check out our [Custom Sounds Guide](CustomSounds.md) for detailed instructions on recording, processing, and adding your own sound packs to KeyEcho.
## 🧑💻 Development
### Prerequisites
#### Installing Rust and Cargo
Cargo is the package manager for Rust. If you don't have it installed, follow these steps:
1. Visit the [Rust installation page](https://www.rust-lang.org/tools/install).
2. Follow the instructions for your operating system to install Rust and Cargo.
3. Verify the installation by running `cargo --version` in your terminal.
#### Installing pnpm
pnpm is a fast, disk space-efficient package manager for JavaScript. To install:
1. Visit the [pnpm installation page](https://pnpm.io/installation).
2. Choose the installation method that suits your operating system.
3. Verify the installation by running `pnpm --version` in your terminal.
### Building and Running the Project
```bash
# Clone the repository
$ git clone [email protected]:ZacharyL2/KeyEcho.git
$ cd KeyEcho
# Install dependencies
$ pnpm install
# Development
$ pnpm dev
# Build
$ pnpm build
# To run the Rust backend separately:
$ cd src-tauri
$ cargo run
# Then, from the root of the project, start the frontend:
$ pnpm web:dev
```