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>
78 lines
2.7 KiB
Markdown
78 lines
2.7 KiB
Markdown
# 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](INSTALLATION.md) - Setup and installation
|
|
- [Quick Start](QUICKSTART.md) - Get up and running in 5 minutes
|
|
- [CLI Reference](CLI_REFERENCE.md) - Complete command-line interface documentation
|
|
|
|
### Core Concepts
|
|
- [Architecture Overview](ARCHITECTURE.md) - System design and components
|
|
- [Database Schema](DATABASE_SCHEMA.md) - SQLite database structure
|
|
- [Data Models](DATA_MODELS.md) - Internal data structures
|
|
- [Color Scheme](COLOR_SCHEME.md) - UI color palette and branding guidelines
|
|
|
|
### Integration
|
|
- [TPDB Integration](TPDB_INTEGRATION.md) - ThePornDB API integration guide
|
|
- [Adult Empire Scraper](ADULT_EMPIRE_SCRAPER.md) - Adult Empire scraper implementation
|
|
- [JAV Studios Reference](JAV_STUDIOS_REFERENCE.md) - Japanese Adult Video studios quick reference
|
|
- [Scraper System](SCRAPER_SYSTEM.md) - How scrapers work
|
|
- [Adding New Sources](ADDING_SOURCES.md) - Implementing new data sources
|
|
|
|
### Development
|
|
- [Development Guide](DEVELOPMENT.md) - Setting up a development environment
|
|
- [Contributing](CONTRIBUTING.md) - How to contribute to Goondex
|
|
- [API Design](API_DESIGN.md) - Internal API design principles
|
|
- [Testing](TESTING.md) - Testing strategies and tools
|
|
|
|
### Configuration
|
|
- [Configuration Reference](CONFIGURATION.md) - All configuration options
|
|
- [Metadata Strategies](METADATA_STRATEGIES.md) - Field merge strategies (Stash-inspired)
|
|
|
|
### Roadmap
|
|
- [Roadmap](ROADMAP.md) - Future plans and versioning
|
|
- [Changelog](CHANGELOG.md) - Version history and changes
|
|
|
|
## 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:
|
|
1. Check the [Troubleshooting Guide](TROUBLESHOOTING.md)
|
|
2. Search [existing issues](issues)
|
|
3. Create a new issue if needed
|
|
|
|
## License
|
|
|
|
[Your License]
|