Skip to content

marmikcfc/bud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Buddy - Your Personal AI Assistant

Buddy is an advanced AI assistant that aims to be your personal companion for various tasks, from simple computer operations to complex data analysis and task automation.

🌟 Features (In Development)

[Previous features sections remain unchanged...]

🚀 Getting Started

Prerequisites

  • Python 3.11+
  • Node.js 18+
  • Electron

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/buddy.git
cd bud-electron
  1. Set up Python environment and install dependencies:
python -m venv env
source env/bin/activate  # On Windows: .\env\Scripts\activate
pip install -r server/requirements.txt
  1. Install Node.js dependencies:
pnpm install

Running the Application

  1. Start the application (this will start both the backend server and Electron app):
pnpm start

The application will start in the system tray. You can:

  • Click the tray icon to open the chat window
  • Use the keyboard shortcut Cmd+Shift+B (Mac) or Ctrl+Shift+B (Windows/Linux) to open the chat window
  • Say "Hey Buddy" (or other wake words) to activate the assistant

🏗️ Project Structure

bud-electron/
├── desktop/           # Electron frontend
│   ├── index.js      # Main process
│   ├── index.html    # Main window
│   └── audioSender.js # Audio streaming
├── server/           # Python backend
│   ├── main.py      # WebSocket server & wake word detection
│   ├── models/      # ML models directory
│   └── requirements.txt # Python dependencies
├── package.json     # Node.js dependencies
└── README.md       # This file

[Rest of the sections remain unchanged...]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published