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