Skip to content

Latest commit

 

History

History
158 lines (109 loc) · 5.45 KB

README.md

File metadata and controls

158 lines (109 loc) · 5.45 KB
Raw

Friend

Open Source AI Wearable device that records everything you say, gives you proactive feedback and advice. 6+ days on single charge.

Friend Image

Discord Follow     License: MIT    GitHub Repo stars

Homepage | Documentation | Buy Assembled Device

Features

  • Real-Time AI Audio Processing: Leverage powerful on-device AI capabilities for real-time audio analysis.
  • Low-powered Bluetooth: Capture audio for 24h+ on a small button battery
  • Open-Source Software: Access and contribute to the pin's software stack, designed with openness and community collaboration in mind.
  • Wearable Design: Experience unparalleled convenience with ergonomic and lightweight design, perfect for everyday wear.

Get Started with our Documentation:

Contribution:

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

How it works

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;
Loading

Structure

There are 3 different apps in these repositories located in different branches and folders. Our goal is to merge them into one big project.

Folder "AppStandalone": Standalone version of the app that doesn't require any hardware to use it.

Folder "AppWithWearable": Wearable-connected version of the app that requires the "Friend necklace" to use it.

Folder "AppWithWearableReactNative": Wearable-connected version of the app that is built in React native

Next Step: Read Getting Started →

Getting Started

Follow these steps to get started with your Friend.

Install the app

Before starting, make sure you have the following installed:

  • Flutter SDK
  • Dart SDK
  • Xcode (for iOS)
  • Android Studio (for Android)
  • CocoaPods (for iOS dependencies)

Setup Instructions

  1. Upgrade Flutter: Before proceeding, make sure your Flutter SDK is up to date:

    flutter upgrade

  2. Get Flutter Dependencies: From within apps/AppStandalone, install flutter packages:

    flutter pub get

  3. Install iOS Pods: Navigate to the iOS directory and install the CocoaPods dependencies:

    cd ios
pod install
pod repo update

  4. Environment Configuration: Create .env using template .env.template

    cd ..
cat .env.template > .env

  5. API Keys: Add your API keys to the .env file. (Sentry is not needed)

  6. Run Build Runner: Generate necessary files with Build Runner:

    dart run build_runner build

  7. Run the App:

    • Select your target device in Xcode or Android Studio.
    • Run the app.

Next Step: Buying Guide →

More links:

Made by the Community, with -❤️-:

Licensing

Friend is available under MIT License