Skip to content

Listen to Mechanical Keyboard Sounds with Every Keystroke - It's Fast

License

Notifications You must be signed in to change notification settings

ZacharyL2/KeyEcho

Repository files navigation

KeyEcho Logo

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.

🚀 Install

Supports Windows (64-bit/ARM64), macOS (Intel/Apple M1/M2), and Linux (64-bit/ARM64/ARMv7).

Visit the release page to download the appropriate installation package.

🧑‍💻 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.
  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.
  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

# Clone the repository
$ git clone [email protected]:ZacharyL2/KeyEcho.git
$ cd KeyEcho

# Install dependencies
$ pnpm install

# Build the Rust backend
$ cd src-tauri
$ cargo build
$ cd ..

# Run the development server
$ pnpm dev

# Build for production
$ pnpm build

# To run the Rust backend separately:

$ cd src-tauri
$ cargo run

# Then, from the root of the project, start the frontend:

$ pnpm dev