Developer Guide on ApplauseLab

Building from Source

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Before building, ensure you have the following installed:

Required

Tool	Version	Installation
Go	1.21+	golang.org
Node.js	18+	nodejs.org
Wails CLI	v2	`go install github.com/wailsapp/wails/v2/cmd/wails@latest`
PortAudio	Latest	See below

Optional (for local transcription)

Tool	Purpose	Installation
whisper-cpp	Local transcription	`brew install whisper-cpp`

Installing PortAudio

macOS

brew install portaudio

Ubuntu/Debian

sudo apt-get install portaudio19-dev

Fedora

sudo dnf install portaudio-devel

Windows

PortAudio is included via CGO bindings. Ensure you have a working C compiler (MinGW or MSVC).

Project Structure

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Yap is built with Wails, combining a Go backend with a React frontend.

yap/
├── app.go # Main application logic
├── main.go # Wails entry point
├── internal/ # Go packages
├── frontend/ # React application
└── build/ # Build assets and output

Entry Points

main.go

Wails application entry point. Configures:

Window size and properties
Menu binding
Asset handling

app.go

Core application struct with methods exposed to the frontend:

Recording state management
Transcription coordination
History management
Configuration

Internal Packages

internal/audio

Audio recording using PortAudio.

Contributing

Mon, 01 Jan 0001 00:00:00 +0000

We welcome contributions to Yap. This guide explains how to get involved.

Ways to Contribute

Bug Reports — Found a bug? Open an issue
Feature Requests — Have an idea? Start a discussion
Code — Fix bugs or implement features
Documentation — Improve docs or add examples
Testing — Test on different platforms

Getting Started

Fork the repository on GitHub
Clone your fork locally
Set up the development environment (see Building)
Create a branch for your changes

git clone https://github.com/YOUR_USERNAME/yap.git
cd yap
git checkout -b feature/your-feature-name

Development Workflow

1. Make Changes

Edit code, add features, fix bugs.