Meetily

https://github.com/zackriya-solutions/meetily
Admin
Meetily is a privacy-first AI meeting assistant that captures, transcribes, and summarizes meetings...
Tokens:22,030
Snippets:266
Trust Score:9.4
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### AMD ROCm Setup and Build

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Installs ROCm tools, sets ROCM_PATH, verifies installation, and builds the project. For AMD GPUs with ROCm support.

```bash
# Ubuntu/Debian
# Add ROCm repository (see https://rocm.docs.amd.com for latest)
sudo apt install rocm-smi hipcc

# Set environment
export ROCM_PATH=/opt/rocm

# Verify
rocm-smi            # Shows GPU info
hipcc --version     # Shows ROCm version

# Build
./build-gpu.sh
```

--------------------------------

### Install frontend dependencies with pnpm

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/BUILDING.md

Installs pnpm and then frontend dependencies with a frozen lockfile to ensure reproducible builds.

```bash
npm install -g pnpm@9.15.9
cd frontend
pnpm install --frozen-lockfile
```

--------------------------------

### Install basic build dependencies on Linux distributions

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/BUILDING.md

Install required build tools using apt, dnf, or pacman depending on the distribution. This is the first step before building.

```bash
# Ubuntu/Debian
sudo apt update
sudo apt install build-essential cmake git

# Fedora/RHEL
sudo dnf install gcc-c++ cmake git

# Arch Linux
sudo pacman -S base-devel cmake git

```

--------------------------------

### Install Dependencies

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Command to install project dependencies using pnpm with a frozen lockfile.

```bash
pnpm install --frozen-lockfile
```

--------------------------------

### Build with NVIDIA GPU (CUDA)

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Install the required NVIDIA drivers and toolkit, verify the installation with nvidia-smi, and run the build script with CUDA-specific environment variables.

```bash
# Install
sudo apt install nvidia-driver-550 nvidia-cuda-toolkit

# Verify
nvidia-smi --query-gpu=compute_cap --format=csv

# Build (adjust architecture for your GPU)
CMAKE_CUDA_ARCHITECTURES=86 \ # (86 may change in your case)
CMAKE_CUDA_STANDARD=17 \
CMAKE_POSITION_INDEPENDENT_CODE=ON \
./build-gpu.sh
```

--------------------------------

### Install macOS dependencies

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/BUILDING.md

Install Homebrew, CMake, Node.js, and pnpm on macOS.

```bash
# Install Homebrew (if not already installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install required tools
brew install cmake node pnpm
```

--------------------------------

### Build Meetily from source on Linux

Source: https://github.com/zackriya-solutions/meetily/blob/main/README.md

Use these commands to clone the repository, install dependencies, and build the project with GPU support.

```bash
git clone https://github.com/Zackriya-Solutions/meeting-minutes
cd meeting-minutes/frontend
pnpm install --frozen-lockfile
./build-gpu.sh
```

--------------------------------

### Build with Vulkan

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Install the Vulkan SDK and OpenBLAS development headers, then configure the environment variables before building.

```bash
# Install
sudo apt install vulkan-sdk libopenblas-dev

# Configure
export VULKAN_SDK=/usr
export BLAS_INCLUDE_DIRS=/usr/include/x86_64-linux-gnu

# Build
./build-gpu.sh
```

--------------------------------

### Install Basic Dependencies for Ubuntu/Debian, Fedora/RHEL, and Arch Linux

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Commands to install build dependencies (build-essential, cmake, git) for various Linux distributions. Use the appropriate block for your distribution.

```bash
# Ubuntu/Debian
sudo apt update
sudo apt install build-essential cmake git
```

```bash
# Fedora/RHEL
sudo dnf install gcc-c++ cmake git
```

```bash
# Arch Linux
sudo pacman -S base-devel cmake git
```

--------------------------------

### macOS Prerequisites Installation

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Commands to install Homebrew, Node.js, Rust, pnpm, and Xcode Command Line Tools on macOS.

```bash
# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js
brew install node

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install pnpm
npm install -g pnpm@9.15.9

# Install Xcode Command Line Tools
xcode-select --install
```

--------------------------------

### Install CUDA Toolkit on Ubuntu/Debian

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Installs NVIDIA driver and CUDA toolkit on Ubuntu/Debian. Verify with nvidia-smi and nvcc --version.

```bash
# Ubuntu/Debian (CUDA 12.x)
sudo apt install nvidia-driver-550 nvidia-cuda-toolkit

# Verify installation
nvidia-smi          # Shows GPU info
nvcc --version      # Shows CUDA version
```

--------------------------------

### Install Vulkan SDK and BLAS on Multiple Distributions

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Installs Vulkan SDK and OpenBLAS on Ubuntu/Debian, Fedora, and Arch Linux. Choose the command for your distribution.

```bash
# Ubuntu/Debian
sudo apt install vulkan-sdk libopenblas-dev

# Fedora
sudo dnf install vulkan-devel openblas-devel

# Arch Linux
sudo pacman -S vulkan-devel openblas
```

--------------------------------

### Build with AMD GPU (ROCm)

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Install ROCm components and set the ROCM_PATH environment variable before running the build script.

```bash
# Install ROCm (see AMD docs for your distro)
sudo apt install rocm-smi hipcc
export ROCM_PATH=/opt/rocm

# Build
./build-gpu.sh
```

--------------------------------

### Rust Template Module Usage

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/src-tauri/templates/README.md

Examples for loading, listing, and validating templates using the Rust templates module.

```rust
use crate::summary::templates;

// Get a specific template
let template = templates::get_template("daily_standup")?;

// List available templates
let available = templates::list_templates();

// Validate custom template JSON
let custom_json = std::fs::read_to_string("custom.json")?;
let validated = templates::validate_template(&custom_json)?;
```

--------------------------------

### Event Pattern for Rust to Frontend Communication

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

Example of emitting an event from Rust and listening for it in the frontend.

```rust
// Rust: Emit transcript updates
app.emit("transcript-update", TranscriptUpdate {
    text: "Hello world".to_string(),
    timestamp: chrono::Utc::now(),
    // ...
})?;
```

```typescript
// Frontend: Listen for events
await listen<TranscriptUpdate>('transcript-update', (event) => {
  setTranscripts(prev => [...prev, event.payload]);
});
```

--------------------------------

### Build with CUDA using build-gpu.sh

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Builds the project with CUDA support. Set CMAKE_CUDA_ARCHITECTURES to your GPU's compute capability (e.g., 86 for RTX 3080). Requires CUDA toolkit installed.

```bash
# Set your GPU's compute capability
# Example: RTX 3080 = 8.6 → use "86"
# Example: GTX 1080 = 6.1 → use "61"

CMAKE_CUDA_ARCHITECTURES=75 \
CMAKE_CUDA_STANDARD=17 \
CMAKE_POSITION_INDEPENDENT_CODE=ON \
./build-gpu.sh
```

--------------------------------

### Command Pattern for Frontend to Rust Communication

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

Example of invoking a Rust command from the frontend and the corresponding Rust command implementation.

```typescript
// Frontend: src/app/page.tsx
await invoke('start_recording', {
  mic_device_name: "Built-in Microphone",
  system_device_name: "BlackHole 2ch",
  meeting_name: "Team Standup"
});
```

```rust
// Rust: src/lib.rs
#[tauri::command]
async fn start_recording<R: Runtime>(
    app: AppHandle<R>,
    mic_device_name: Option<String>,
    system_device_name: Option<String>,
    meeting_name: Option<String>
) -> Result<(), String> {
    // Implementation delegates to audio::recording_commands
}
```

--------------------------------

### Run and Build App (Windows)

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Scripts for running the app in development or production mode on Windows.

```cmd
clean_run_windows.bat
```

```cmd
clean_build_windows.bat
```

--------------------------------

### Clone Repository and Navigate (macOS)

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Commands to clone the repository and enter the frontend directory on macOS.

```bash
git clone https://github.com/Zackriya-Solutions/meeting-minutes
cd meeting-minutes/frontend
```

--------------------------------

### Test Notification Immediately

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/src-tauri/NOTIFICATION_TESTING.md

Initializes the notification system and shows a test notification. Use this command to quickly verify notifications are working.

```javascript
// This will initialize the notification system and show a test notification
await invoke('test_notification_with_auto_consent');
```

--------------------------------

### Build with Vulkan using build-gpu.sh

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Builds the project with Vulkan support. The script automatically detects Vulkan and builds with --features vulkan.

```bash
./build-gpu.sh
```

--------------------------------

### Build and Run Meetily with dev-gpu.sh and build-gpu.sh

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Commands to run the development mode with hot reload and to create a production build. The scripts automatically detect the GPU and configure acceleration.

```bash
# Development mode (with hot reload)
./dev-gpu.sh
```

```bash
# Production build
./build-gpu.sh
```

--------------------------------

### Build and run on macOS

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/BUILDING.md

Commands to run the application in development mode or create a production build on macOS.

```bash
# Development mode (with hot reload)
pnpm tauri:dev

# Production build
pnpm tauri:build
```

--------------------------------

### Frontend Development Commands for Tauri Desktop App

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

Commands for building, running, and managing dependencies for the Tauri-based frontend. Includes platform-specific scripts for macOS and Windows, as well as GPU-specific build configurations.

```bash
# macOS Development
./clean_run.sh              # Clean build and run with info logging
./clean_run.sh debug        # Run with debug logging
./clean_build.sh            # Production build

# Windows Development
clean_run_windows.bat       # Clean build and run
clean_build_windows.bat     # Production build

# Manual Commands
pnpm install                # Install dependencies
pnpm run dev                # Next.js dev server (port 3118)
pnpm run tauri:dev          # Full Tauri development mode
pnpm run tauri:build        # Production build

# GPU-Specific Builds (for testing acceleration)
pnpm run tauri:dev:metal    # macOS Metal GPU
pnpm run tauri:dev:cuda     # NVIDIA CUDA
pnpm run tauri:dev:vulkan   # AMD/Intel Vulkan
pnpm run tauri:dev:cpu      # CPU-only (no GPU)
```

--------------------------------

### Frontend and Backend Development Commands

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Commands to run the Next.js frontend or the Tauri development server independently.

```bash
pnpm run dev
```

```bash
pnpm run tauri:dev
```

--------------------------------

### Available Commands for Testing

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/src-tauri/NOTIFICATION_TESTING.md

Lists all available invoke commands for testing notifications, including system status, permissions, testing, and settings.

```javascript
// System status
await invoke('is_notification_system_ready');
await invoke('get_system_dnd_status');
await invoke('get_notification_stats');

// Permissions and consent
await invoke('request_notification_permission');
await invoke('set_notification_consent', { consent: true });

// Testing
await invoke('test_notification_with_auto_consent');
await invoke('show_test_notification');

// Settings
await invoke('get_notification_settings');
```

--------------------------------

### Run and Build App (macOS)

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Scripts for running the app in development, production, or debug mode on macOS.

```bash
./clean_run.sh
```

```bash
./clean_build.sh
```

```bash
./clean_run.sh debug
```

--------------------------------

### Project Structure Overview

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

The directory layout of the Meetily frontend project.

```text
/frontend
├── src/                   # Next.js frontend code
├── src-tauri/             # Rust backend for Tauri
├── public/                # Static assets
└── package.json           # Project dependencies
```

--------------------------------

### Configure Vulkan Environment Variables

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Sets VULKAN_SDK and BLAS_INCLUDE_DIRS environment variables and applies them. Add to ~/.bashrc or ~/.zshrc for persistence.

```bash
# Add to ~/.bashrc or ~/.zshrc
export VULKAN_SDK=/usr
export BLAS_INCLUDE_DIRS=/usr/include/x86_64-linux-gnu

# Apply changes
source ~/.bashrc
```

--------------------------------

### Build for CPU-only

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Execute the build script directly for CPU-only environments.

```bash
# Just build - works out of the box
./build-gpu.sh
```

--------------------------------

### Initialize Notification System Manually

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/src-tauri/NOTIFICATION_TESTING.md

Initializes the notification manager manually, then shows a test notification. Use these two commands in sequence when you need to control initialization separately.

```javascript
// Initialize the notification system
await invoke('initialize_notification_manager_manual');
```

```javascript
// Then show a test notification
await invoke('show_test_notification');
```

--------------------------------

### Clone the repository

Source: https://github.com/zackriya-solutions/meetily/blob/main/CONTRIBUTING.md

Use this command to clone your fork of the repository to your local machine.

```bash
git clone https://github.com/YOUR_USERNAME/meeting-minutes.git
```

--------------------------------

### Performance-Critical Logging Macros

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/src-tauri/LOGGING_OPTIMIZATIONS.md

Use these macros in hot paths to eliminate overhead in release builds. perf_debug! and perf_trace! are zero-cost in release, while async_info! provides non-blocking logging for non-critical updates.

```rust
use crate::{perf_debug, perf_trace};

// Use performance-optimized macros in hot paths
perf_debug!("Processing chunk {}", chunk_id);  // Zero cost in release

// Use async logging for non-critical info
async_info!("Status update: {}", status);     // Non-blocking
```

--------------------------------

### Git Workflow Commands

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Standard commands for contributing to the repository.

```bash
git checkout -b feature/amazing-feature
git commit -m 'Add some amazing feature'
git push origin feature/amazing-feature
```

--------------------------------

### Set environment variables for Vulkan dependencies

Source: https://github.com/zackriya-solutions/meetily/blob/main/docs/building_in_linux.md

Configure the VULKAN_SDK and BLAS_INCLUDE_DIRS environment variables to resolve missing dependency errors during the build.

```bash
export VULKAN_SDK=/usr
export BLAS_INCLUDE_DIRS=/usr/include/x86_64-linux-gnu
```

--------------------------------

### Tauri Package Scripts

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Direct package scripts for running or building the Tauri application.

```bash
pnpm run tauri:dev
pnpm run tauri:build
```

--------------------------------

### Make Scripts Executable (macOS)

Source: https://github.com/zackriya-solutions/meetily/blob/main/frontend/README.md

Command to grant execution permissions to the build and run scripts on macOS.

```bash
chmod +x clean_run.sh clean_build.sh
```

--------------------------------

### Audio System Directory Structure

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

File structure of the modularized audio system components.

```text
audio/
├── devices/                    # Device discovery and configuration
│   ├── discovery.rs           # list_audio_devices, trigger_audio_permission
│   ├── microphone.rs          # default_input_device
│   ├── speakers.rs            # default_output_device
│   ├── configuration.rs       # AudioDevice types, parsing
│   └── platform/              # Platform-specific implementations
│       ├── windows.rs         # WASAPI logic (~200 lines)
│       ├── macos.rs           # ScreenCaptureKit logic
│       └── linux.rs           # ALSA/PulseAudio logic
├── capture/                   # Audio stream capture
│   ├── microphone.rs          # Microphone capture stream
│   ├── system.rs              # System audio capture stream
│   └── core_audio.rs          # macOS ScreenCaptureKit integration
├── pipeline.rs                # Audio mixing and VAD processing
├── recording_manager.rs       # High-level recording coordination
├── recording_commands.rs      # Tauri command interface
└── recording_saver.rs         # Audio file writing
```

--------------------------------

### Test audio pipeline changes

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

Use the RUST_LOG environment variable to enable verbose audio logging during execution.

```bash
# Enable verbose audio logging
RUST_LOG=app_lib::audio=debug ./clean_run.sh

# Monitor audio metrics in real-time
# Check Developer Console in the app (Cmd+Shift+I on macOS)
```

--------------------------------

### Enable Rust Logging

Source: https://github.com/zackriya-solutions/meetily/blob/main/CLAUDE.md

Commands to enable debug logging for the Rust backend on macOS and Windows.

```bash
# macOS
RUST_LOG=debug ./clean_run.sh

# Windows (PowerShell)
$env:RUST_LOG="debug"; ./clean_run_windows.bat
```

--------------------------------

### Create a feature branch

Source: https://github.com/zackriya-solutions/meetily/blob/main/CONTRIBUTING.md

Commands to switch to the devtest branch, pull the latest changes, and create a new feature branch.

```bash
git checkout devtest
git pull upstream devtest
git checkout -b feature/your-feature-name
```
Tokens:
Raw