Stu Leak
2b4a2038fa
- Add comprehensive JAV studios quick reference guide - Update documentation index with JAV reference - Add logo animation components and test files - Update CSS styling for cards, buttons, forms, and theme - Add utility scripts for configuration and import workflows - Update templates and UI components 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2.7 KiB
2.7 KiB
Goondex Documentation
Version: v0.1.0-dev2 Last Updated: 2025-11-14
Welcome to Goondex
Goondex is a fast, local-first media indexer for adult content. It ingests metadata from external sources (like ThePornDB), normalizes it, and stores it in a lightweight SQLite database for quick search and retrieval.
Documentation Structure
Getting Started
- Installation Guide - Setup and installation
- Quick Start - Get up and running in 5 minutes
- CLI Reference - Complete command-line interface documentation
Core Concepts
- Architecture Overview - System design and components
- Database Schema - SQLite database structure
- Data Models - Internal data structures
- Color Scheme - UI color palette and branding guidelines
Integration
- TPDB Integration - ThePornDB API integration guide
- Adult Empire Scraper - Adult Empire scraper implementation
- JAV Studios Reference - Japanese Adult Video studios quick reference
- Scraper System - How scrapers work
- Adding New Sources - Implementing new data sources
Development
- Development Guide - Setting up a development environment
- Contributing - How to contribute to Goondex
- API Design - Internal API design principles
- Testing - Testing strategies and tools
Configuration
- Configuration Reference - All configuration options
- Metadata Strategies - Field merge strategies (Stash-inspired)
Roadmap
Key Features
Current (v0.1.0-dev2)
- ✅ SQLite database with WAL mode
- ✅ Full CRUD operations for performers, studios, scenes, and tags
- ✅ TPDB scraper with real API integration
- ✅ CLI search commands (local database)
- ✅ CLI import commands (fetch from TPDB)
- ✅ Relationship management (scenes ↔ performers, scenes ↔ tags)
Planned
- ⏳ Stash-style metadata resolution (field strategies)
- ⏳ Image caching and management
- ⏳ TUI (Terminal UI) browser
- ⏳ Background daemon (goondexd)
- ⏳ Web UI
Quick Links
- GitHub: [Your Repo URL]
- Issue Tracker: [Your Repo URL]/issues
- ThePornDB: https://theporndb.net
- API Documentation: https://api.theporndb.net/docs
Support
For help and support:
- Check the Troubleshooting Guide
- Search existing issues
- Create a new issue if needed
License
[Your License]