Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These are supported funding model platforms

github: orangekame3
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For questions about usage or development, create an issue using the **Question**
### Prerequisites

- Node.js 22+
- npm
- bun
- Docker (optional, for VOICEVOX)

### Local Development
Expand All @@ -45,13 +45,13 @@ git clone https://github.com/orangekame3/mirrormate.git
cd mirrormate

# Install dependencies
npm install
bun install

# Copy environment file
cp .env.example .env

# Start development server
npm run dev
bun run dev
```

### Docker Development
Expand Down Expand Up @@ -89,20 +89,20 @@ Run tests before submitting changes:

```bash
# Run tests once
npm run test
bun run test

# Run tests in watch mode during development
npm run test:watch
bun run test:watch
```

### Pull Requests

1. Fork the repository
2. Create a feature branch (`git checkout -b feat/amazing-feature`)
3. Make your changes
4. Run lint check (`npm run lint`)
5. Run tests (`npm run test`)
6. Run build (`npm run build`)
4. Run lint check (`bun run lint`)
5. Run tests (`bun run test`)
6. Run build (`bun run build`)
7. Commit your changes
8. Push to your fork
9. Open a Pull Request
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ cd mirrormate
docker compose up -d
```

**Wake word**: Say "OK Mira" to activate.
**Wake word**: Say "Hey Mira" to activate.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/config/character.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ character:

wakeWord:
enabled: true
phrase: "OK Mira"
phrase: "Hey Mira"
timeout: 60

appearance:
Expand Down Expand Up @@ -107,7 +107,7 @@ character:
| `name` | string | Character's name |
| `description` | string | Brief description of the character |
| `wakeWord.enabled` | boolean | Enable wake word detection |
| `wakeWord.phrase` | string | Wake word phrase (e.g., "OK Mirror") |
| `wakeWord.phrase` | string | Wake word phrase (e.g., "Hey Mira") |
| `wakeWord.timeout` | number | Seconds before returning to waiting mode |
| `appearance` | list | Physical appearance traits |
| `personality` | list | Personality traits |
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Open http://localhost:3000 in Chrome.

> Set `LOCALE=en` for English or `LOCALE=ja` for Japanese (default).

Say **"OK Mira"** (English) or **"OK ミラ"** (Japanese) to start talking!
Say **"Hey Mira"** (English) or **"OK ミラ"** (Japanese) to start talking!

### Option 2: Ollama + VOICEVOX (No API key required)

Expand Down
12 changes: 6 additions & 6 deletions docs/guide/recommended-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ flowchart TB
end

subgraph MacBook["MacBook (Development)"]
Dev["npm run dev<br/>:3000"]
Dev["bun run dev<br/>:3000"]
end

App -->|LLM| Ollama
Expand Down Expand Up @@ -221,8 +221,8 @@ With this setup, development requires no local services:

```bash
cd mirrormate
npm install
npm run dev
bun install
bun run dev
```

The app connects to Mac Studio for all heavy processing via Tailscale.
Expand Down Expand Up @@ -316,13 +316,13 @@ docker compose up -d

```bash
# Start dev server
npm run dev
bun run dev

# Build
npm run build
bun run build

# Test
npm run test
bun run test
```

## Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ hero:
features:
- icon: 🎙️
title: Voice Interaction
details: Real-time speech recognition with wake word activation. Just say "OK Mirror" to start.
details: Real-time speech recognition with wake word activation. Just say "Hey Mira" to start.
- icon: 🧠
title: Personalized Memory
details: RAG-based memory system that remembers your preferences and conversation context.
Expand Down