mirror of
https://github.com/9x/sheetmusictrainer.git
synced 2026-11-03 22:03:54 +01:00
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
# Sheet Music Trainer
|
|
|
|
A web-based application designed to help musicians practice sight-reading and ear training. It listens to your instrument (or voice) via the microphone and gives real-time feedback.
|
|
|
|
[Live Demo](https://9x.github.io/sheetmusictrainer/) (If available)
|
|
|
|
## Features
|
|
|
|
- **Sight Reading Mode**: Read notes from the interactive staff and play them on your instrument. The app listens and confirms when you hit the correct note.
|
|
- **Ear Training Mode**: Listen to a reference note and try to reproduce it. The reference note duration is configurable, and it can optionally wait for your instrument to go quiet before the next one plays.
|
|
- **Phrase Mode**: Practice short phrases — several bars of a single-voice line. Material: generated melodies (any key/mode, seeded), scale drills (one/two octaves or within a fretboard position, up/down/up-down), bundled exercises (verified public-domain melodies + original studies), or your own `.abc` files. Two paces: *at your pace* (beginner, waits for each note) and *with tempo* (metronome count-in, forgiving hit/miss tracking). Note that matching checks pitch, not fingering, and repeated identical notes need a brief release between them.
|
|
- **Real-time Pitch Detection**: Uses your device's microphone to detect notes instantly, with an analysis window and detector adapted to your instrument.
|
|
- **Chromatic Tuner**: Tunable needle with cents display, always-on when enabled.
|
|
- **Instrument Support**: Optimized for Guitar, Bass, Piano, Voice and Whistle, with configurable tunings for guitar and bass.
|
|
- **Virtual Instruments**: On-screen interactive guitar fretboard and piano keys for visual reference or touch input.
|
|
- **Customizable**: Difficulty (range, accidentals), key signatures, rhythm/metronome settings, reference note duration, microphone sensitivity, and more.
|
|
- **Dark & Light Themes**: Full theme support including native form controls.
|
|
- **Zen Mode**: Distraction-free practice interface.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js (v18 or higher recommended)
|
|
- npm
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://github.com/9x/sheetmusictrainer.git
|
|
cd sheetmusictrainer
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Run the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
4. Open your browser and navigate to the local URL provided (usually `http://localhost:5173`).
|
|
|
|
## Technical Details
|
|
|
|
100% vibe coded using Google Antigravity and Gemini 3 pro.
|
|
|
|
This project is built with:
|
|
- React + TypeScript
|
|
- Vite
|
|
- VexFlow (for music notation)
|
|
- Pitchfinder (for audio detection)
|
|
|
|
For more details on the architecture, see [TECHNICAL_REALIZATION.md](./TECHNICAL_REALIZATION.md).
|
|
|
|
## License
|
|
|
|
MIT
|