amical/README.md

<!-- Markdown with HTML -->
<div align="center">
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://amical.ai/github-readme-header-dark.png">
  <source media="(prefers-color-scheme: light)" srcset="https://amical.ai/github-readme-header-light.png">
  <img alt="Amical" src="https://amical.ai/github-readme-header-light.png">
</picture>
</div>

<p align="center">
  <a href='http://makeapullrequest.com'>
    <img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields'/>
  </a>
  <a href="https://opensource.org/license/agpl-v3/">
    <img src="https://img.shields.io/github/license/amicalhq/amical?logo=opensourceinitiative&logoColor=white&label=License&color=8A2BE2" alt="license">
  </a>
  <br>
  <a href="https://amical.ai/community">
    <img src="https://img.shields.io/badge/discord-7289da.svg?style=flat-square&logo=discord" alt="discord" style="height: 20px;">
  </a>
</p>

<p align="center">
  <a href="https://amical.ai">Website</a> - <a href="https://amical.ai/docs">Docs</a> - <a href="https://amical.ai/community">Community</a> - <a href="https://github.com/amicalhq/amical/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a>
</p>

## Table of Contents

- [🔮 Overview](#-overview)
- [✨ Features](#-features)
- [🔰 Tech Stack](#-tech-stack)
- [🤗 Contributing](#-contributing)
- [🎗 License](#-license)

> [!CAUTION]
> Amical is in active development towards its first release, expect bugs and breaking changes.

## 🔮 Overview

Open Source Speech-to-Text App powered by Gen AI\
Type 10x faster, no keyboard needed. Fast, Accurate, Context-aware and Private.

## ✨ Features
> ✔︎ - Done, ◑ - In Progress, ◯ - Planned
### Apps

◑<span style="color: #a855f7"> Mac</span>
◯<span style="color: #a855f7"> Windows</span>
◯<span style="color: #a855f7"> Linux</span>
◯<span style="color: #a855f7"> iOS</span>
◯<span style="color: #a855f7"> Android</span>

### Core Features

◑<span style="color: #22C55E"> Context-Awareness</span>
<span style="color: #808080">Recognize context based on the apps being used in the background to customize transcription based on use case.</span>

◑<span style="color: #22C55E"> Custom Hotkeys</span>
<span style="color: #808080">Configure your own keyboard shortcuts for common transcription actions (start/stop, commands).</span>

◑<span style="color: #22C55E"> Desktop Widget</span>
<span style="color: #808080">A floating, easily accessible widget to control transcription without leaving your workflow.</span>

◑<span style="color: #22C55E"> Multi-Language Support</span>
<span style="color: #808080">Support for multiple languages and dialects for global usability.</span>

◯<span style="color: #22C55E"> Audio/Video Transcription</span>
<span style="color: #808080">Transcribe uploaded audio and video files into text.</span>

◯<span style="color: #22C55E"> Custom Vocabulary</span>
<span style="color: #808080">Add custom terms, such as names, technical terms, or slang, for better accuracy.</span>

◯<span style="color: #22C55E"> Automatic Vocabulary</span>
<span style="color: #808080">Dynamically learn new words based on usage.</span>

◯<span style="color: #22C55E"> Bring Your Own Key</span>
<span style="color: #808080">Use your own API keys for AI models within the app.</span>

◯<span style="color: #22C55E"> Bring Your Own Model</span>
<span style="color: #808080">Point to any AI model within the app.</span>

### Integrations & Workflow

◯<span style="color: #22C55E"> MCP Integrations</span>
<span style="color: #808080">Seamlessly integrate your apps via MCP for control and command.</span>

◯<span style="color: #22C55E"> Voice Commands</span>
<span style="color: #808080">Control desktop apps and transcription processes via native and custom integrations.</span>

◯<span style="color: #22C55E"> Integration Framework</span>
<span style="color: #808080">Framework and devkit to build your own integrations.</span>

### Enhancements

◯<span style="color: #22C55E"> Text Editing</span>
<span style="color: #808080">Inline editing of transcribed text via voice commands.</span>

◯<span style="color: #22C55E"> Transcription History</span>
<span style="color: #808080">Maintain an easily searchable history of transcribed texts, with export options.</span>

◯<span style="color: #22C55E"> Note Taking</span>
<span style="color: #808080">Take quick notes with voice within the app.</span>

◯<span style="color: #22C55E"> Custom Prompts</span>
<span style="color: #808080">Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc.</span>

◯<span style="color: #22C55E"> Meeting Transcription</span>
<span style="color: #808080">Record live meetings with both mic and system audio for seamless transcription.</span>

## 🔰 Tech Stack

- 🧑‍💻 [Typescript](https://www.typescriptlang.org/)
- 🖥️ [Electron](https://electronjs.org/)
- ☘️ [Next.js](https://nextjs.org/)
- 🎨 [TailwindCSS](https://tailwindcss.com/)
- 🧑🏼‍🎨 [Shadcn](https://ui.shadcn.com/)
- 🔒 [Better-Auth](https://better-auth.com/)
- 🧘‍♂️ [Zod](https://zod.dev/)
- 🐞 [Jest](https://jestjs.io/)
- 📚 [Fumadocs](https://github.com/fuma-nama/fumadocs)
- 🌀 [Turborepo](https://turbo.build/)

## 🤗 Contributing

Contributions are welcome! Please read the [Contributing Guide][contributing] to get started.

- **💡 [Contributing Guide][contributing]**: Learn about our contribution process and coding standards.
- **🐛 [Report an Issue][issues]**: Found a bug? Let us know!
- **💬 [Start a Discussion][discussions]**: Have ideas or suggestions? We'd love to hear from you.

# 🎗 License

Released under [AGPLv3][license].

<!-- REFERENCE LINKS -->
[contributing]: https://github.com/amicalhq/amical/blob/main/CONTRIBUTING.md
[license]: https://github.com/amicalhq/amical/blob/main/LICENSE
[discussions]: https://discuss.amical.ai
[issues]: https://github.com/amicalhq/amical/issues
[pulls]: https://github.com/amicalhq/amical/pulls "submit a pull request"