upload to github

2025-06-07 16:14:00 +02:00 · 2025-06-07 16:14:00 +02:00 · ae9ca74ac6
commit ae9ca74ac6
23 changed files with 2133 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,160 @@
+# Beat harvester
+
+(another ytdlp gui)
+
+A music downloader app with a modern web interface. Built with Go for maximum performance and easy deployment.
+
+## Features
+
+- **Modern Web UI** - Clean, responsive interface with real-time updates
+- **High-Quality Downloads** - Up to 320kbps - limited by origin, with automatic metadata embedding
+- **Smart Thumbnails** - Auto-crop and embed album artwork
+- **Mobile-Friendly** - Responsive design for all devices
+- **Efficiency:** - Idle memory usage: ~5MB
+
+Screenshot:
+
+<img src="./screen1.png" alt="Screenshot of UI" width="411px" height="446px">
+
+## Quick Start
+
+### 1. Build from Source
+
+```bash
+# Clone repository
+git clone https://github.com/JRoshthen1/beat-harvester.git
+cd beat-harvester
+
+# Install system dependencies
+make install-deps-ubuntu  # Ubuntu/Debian
+# or
+make install-deps-centos  # CentOS/RHEL
+# or
+make install-deps-macos   # macOS
+
+# Build and run
+make build
+make run
+```
+
+### 2. Access the Web Interface
+
+Open your browser to `http://localhost:3000`
+
+## Prerequisites
+
+### System Dependencies
+
+The application requires these external tools:
+
+- **yt-dlp** - YouTube download tool
+- **ffmpeg** - Audio processing
+- **ffprobe** - Metadata extraction
+- **dwebp** (optional) - Thumbnail processing
+
+## Building
+
+### Development Build
+
+```bash
+# Install Go dependencies
+make deps
+
+# Build for current platform
+make build
+
+# Run with hot reload (if you have air installed)
+make dev
+```
+
+### Production Builds
+
+```bash
+# Build for all platforms
+make build-all
+
+# Build for specific platforms
+make build-linux    # Linux (amd64 + arm64)
+make build-darwin   # macOS (amd64 + arm64)
+make build-windows  # Windows (amd64)
+
+# Create release packages
+make package
+```
+
+## Deployment Options
+
+### 1. Standalone Server
+
+```bash
+# Run directly
+./beat-harvester
+
+# With custom configuration
+PORT=8080 OUTPUT_PATH=/music ./beat-harvester
+
+# Background process
+nohup ./beat-harvester > server.log 2>&1 &
+
+# Systemd
+# see ./beat-harvester.service
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable      | Default       | Description 
+|---------------|---------------|--------------------------------
+| `PORT`        | `3000`        | Server port 
+| `OUTPUT_PATH` | `$HOME/Music` | Default music output directory 
+
+## API Reference
+
+### Endpoints
+
+| Method |   Endpoint    | Description 
+|--------|---------------|----------------------
+| POST   | /api/download | # Start a download
+| GET    | /api/health   | # Health check  
+| WS     | /ws           | # WebSocket logs
+| GET    | /             | # Frontend interface
+
+### Download Request
+
+```json
+{
+  "albumName": "My Album",
+  "ytLink": "https://youtube.com/watch?v=...",
+  "audioQuality": "0",
+  "audioFormat": "mp3",
+  "embedThumbnail": true,
+  "cropThumbnail": true,
+  "outputPath": "/custom/path"
+}
+```
+
+### Download Response
+
+```json
+{
+  "success": true,
+  "message": "Operations complete!",
+  "fileName": "song.mp3",
+  "filePath": "/path/to/song.mp3",
+  "albumName": "My Album",
+  "originalTitle": "Original Song Title",
+  "audioQuality": "320kbps",
+  "audioFormat": "MP3"
+}
+```
+
+## Acknowledgments
+
+- **yt-dlp** - Powerful YouTube downloader
+- **FFmpeg** - Audio processing toolkit
+- **Gorilla** - Go web toolkit
+
+---
+
+**Note**: This tool is for downloading content you have the right to download.