We welcome contributions from the community! If you are interested in improving Friend, check out our current tasks
We also want to give back to the community - and therefore, some of the tasks are paid bounties 💰! You can check which ones by the "Paid Bounty" label, here
graph TD;
A[Device] -- Streams Audio --> B[Phone App];
B -- Transmits --> C[Deepgram];
C -- Returns Transcript --> D[Phone App];
D -- Sends Transcript to Plugins Enabled --> G[Community Plugins];
D -- Saves Original Transcript --> E[Phone Storage];
G -- Saves Plugin Responses --> E;
classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333;
classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF;
classDef lightModeLinks stroke:#333333;
classDef darkModeLinks stroke:#FFFFFF;
class A,B,C,D,E,G lightMode;
class A,B,C,D,E,G darkMode;
linkStyle 0 stroke:#FF4136, stroke-width:2px;
linkStyle 1 stroke:#1ABC9C, stroke-width:2px;
linkStyle 2 stroke:#0074D9, stroke-width:2px;
linkStyle 3 stroke:#FFCC00, stroke-width:2px;
linkStyle 4 stroke:#2ECC40, stroke-width:2px;
linkStyle 5 stroke:#B10DC9, stroke-width:2px;
Get the Android app on Google Play
Download the iOS app in App Store
iOS app beta on TestFlight
Latest firmware: v1.0.2
Or you can build your own app from the sources in apps/AppWithWearable
and firmware from firmware
folders.
Next Step: Read Getting Started →
Follow these steps to get started with your Friend.
Before starting, make sure you have the following installed:
Upgrade Flutter: Before proceeding, make sure your Flutter SDK is up to date:
flutter upgrade
Get Flutter Dependencies:
From within apps/AppWithWearable
, install flutter packages:
flutter pub get
Install iOS Pods: Navigate to the iOS directory and install the CocoaPods dependencies:
cd ios
pod install
pod repo update
Environment Configuration:
Create .env
using template .env.template
cd ..
cat .env.template > .env
API Keys:
Add your API keys to the .env
file. (Sentry is not needed)
Run Build Runner: Generate necessary files with Build Runner:
dart run build_runner build
Run the App:
Friend is available under MIT License