Initial commit of Hearbit AI App
This commit is contained in:
67
README.md
Normal file
67
README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Hearbit AI 🦉🎙️
|
||||
|
||||
Hearbit AI is a powerful macOS desktop application designed to record system and microphone audio, transcribe it using Infomaniak's Whisper API, and generate intelligent AI summaries.
|
||||
|
||||
## Features
|
||||
|
||||
* **Dual-Channel Recording**: Capture both your microphone (e.g., for voice notes) and system audio (e.g., for meetings) simultaneously.
|
||||
* **Powered by Infomaniak AI**:
|
||||
* **Transcription**: High-accuracy speech-to-text using Infomaniak's Whisper integration.
|
||||
* **Summarization**: Generate concise summaries, action items, or meeting notes using models like Mixtral or Llama 3 via Infomaniak's LLM API.
|
||||
* **Auto-Save**: Recordings and summaries are automatically saved to a persistent history.
|
||||
* **Customizable Prompts**: Define your own AI templates (e.g., "Summarize", "Extract Action Items", "Translate").
|
||||
* **Privacy-Focused**: Processed securily via your own Infomaniak API keys.
|
||||
|
||||
## prerequisites
|
||||
|
||||
* **macOS** (Apple Silicon or Intel)
|
||||
* **Infomaniak AI Account**: You need an API Key and Product ID from [Infomaniak's Developer Portal](https://manager.infomaniak.com/).
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the latest release (`.dmg` or `.app`).
|
||||
2. Drag **Hearbit AI** to your `Applications` folder.
|
||||
3. (Optional) To record system audio, install the [BlackHole 2ch Driver](https://existential.audio/blackhole/).
|
||||
|
||||
## Usage
|
||||
|
||||
1. **Configure**:
|
||||
* Click the **Settings** (gear icon) in the top right.
|
||||
* Enter your **Infomaniak API Key** and **Product ID**.
|
||||
* (Optional) Customize your AI prompts.
|
||||
2. **Record**:
|
||||
* Select your **Input Device** (e.g., "MacBook Pro Microphone" or an aggregate device for system audio).
|
||||
* Select an **LLM Model** (e.g., Mixtral).
|
||||
* Click **Start Recording**.
|
||||
3. **Process**:
|
||||
* Click **Stop Recording**.
|
||||
* The app will automatically upload, transcribe, and summarize your audio.
|
||||
4. **History**:
|
||||
* Click **Records** to view past recordings.
|
||||
|
||||
## Development
|
||||
|
||||
This app is built with **Tauri**, **React**, and **TypeScript**.
|
||||
|
||||
### Setup
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Run Locally
|
||||
```bash
|
||||
npm run dev
|
||||
# OR
|
||||
npm run tauri dev
|
||||
```
|
||||
|
||||
### Build for Production
|
||||
```bash
|
||||
npm run tauri build
|
||||
```
|
||||
|
||||
## Icons
|
||||
The app uses a custom generated icon set located in `src-tauri/icons`.
|
||||
|
||||
## License
|
||||
[License Name]
|
||||
Reference in New Issue
Block a user