amical

<!-- 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/MIT/"> <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 AI Dictation and Note-taking\ Dictate hands-free, transcribe meetings, and capture notes effortlessly - powered by Gen AI ## ✨ Features > ✔︎ - Done, ◑ - In Progress, ◯ - Planned ### 📱 Apps ◑ `Mac` ◯ `Windows` ◯ `Linux` ◯ `iOS` ◯ `Android` ### ⚡ Core Features ✔︎<kbd>Context-Awareness</kbd>\ ^{Recognize context based on the apps being used in the background to customize transcription based on use case.}\ ◑<kbd>Note Taking</kbd>\ ^{Take quick notes with voice within the app.}\ ◑<kbd>Meeting Transcription</kbd>\ ^{Record live meetings with both mic and system audio for seamless transcription.}\ ◑<kbd>Automatic Meeting Notes</kbd>\ ^{Generate meeting notes using transcriptions and templates}\ ◑<kbd>Custom Hotkeys</kbd>\ ^{Configure your own keyboard shortcuts for common transcription actions (start/stop, commands).}\ ✔︎<kbd>Desktop Widget</kbd>\ ^{A floating, easily accessible widget to control transcription without leaving your workflow.}\ ✔︎<kbd>Multi-Language Support</kbd>\ ^{Support for multiple languages and dialects for global usability.}\ ✔︎<kbd>Custom Vocabulary</kbd>\ ^{Add custom terms, such as names, technical terms, or slang, for better accuracy.}\ ◯<kbd>Automatic Vocabulary</kbd>\ ^{Dynamically learn new words based on usage.}\ ◑<kbd>Bring Your Own Key</kbd>\ ^{Use your own API keys for AI models within the app.}\ ✔︎<kbd>Bring Your Own Model (Ollama)</kbd>\ ^{Point to any AI model within the app.} ### 🔗 Integrations & Workflow ◯<kbd>MCP Integrations</kbd>\ ^{Seamlessly integrate your apps via MCP for control and command.}\ ◯<kbd>Voice Commands</kbd>\ ^{Control desktop apps and transcription processes via native and custom integrations.}\ ◯<kbd>Integration Framework</kbd>\ ^{Framework and devkit to build your own integrations.} ### 🌟 Enhancements ◯<kbd>Text Editing</kbd>\ ^{Inline editing of transcribed text via voice commands.}\ ◯<kbd>Transcription History</kbd>\ ^{Maintain an easily searchable history of transcribed texts, with export options.}\ ◯<kbd>Custom Prompts</kbd>\ ^{Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc.}\ ## 🔰 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 [MIT][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"