Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.96 KB

README.md

File metadata and controls

65 lines (41 loc) · 1.96 KB
Raw

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.

🎵 Custom Sounds

Want to create your own keyboard sounds? Check out our Custom Sounds Guide 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.
  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 git@github.com: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