# FootyCollect

> Django project to manage your inventory of football memorabilia collection

## Docs

- [API Authentication](https://docs.footycollect.sunr4y.dev/api/authentication.md): Authenticate your API requests using token-based authentication
- [Collection Endpoints](https://docs.footycollect.sunr4y.dev/api/endpoints/collections.md): API endpoints for managing user collections in FootyCollect
- [Item Endpoints](https://docs.footycollect.sunr4y.dev/api/endpoints/items.md): API endpoints for managing football memorabilia items in FootyCollect
- [Photo Endpoints](https://docs.footycollect.sunr4y.dev/api/endpoints/photos.md): API endpoints for managing item photos in FootyCollect
- [User Endpoints](https://docs.footycollect.sunr4y.dev/api/endpoints/users.md): API endpoints for managing users in FootyCollect
- [Bulk Operations with FKAPI](https://docs.footycollect.sunr4y.dev/api/fkapi/bulk-operations.md): Learn how to perform bulk operations for importing multiple kits and user collections from FKAPI
- [FKAPI Integration Overview](https://docs.footycollect.sunr4y.dev/api/fkapi/overview.md): Learn how FootyCollect integrates with the Football Kit Archive API (FKAPI) for kit data and metadata
- [Searching Kits via FKAPI](https://docs.footycollect.sunr4y.dev/api/fkapi/search-kits.md): Learn how to search for football kits using the FKAPI integration
- [API Introduction](https://docs.footycollect.sunr4y.dev/api/introduction.md): Overview of the FootyCollect REST API
- [Rate Limiting](https://docs.footycollect.sunr4y.dev/api/rate-limiting.md): Understanding API rate limits and throttling policies
- [Database Schema](https://docs.footycollect.sunr4y.dev/architecture/database-schema.md): Database models, relationships, and schema design for FootyCollect
- [Multi-Table Inheritance](https://docs.footycollect.sunr4y.dev/architecture/multi-table-inheritance.md): Multi-table inheritance pattern for modeling different item types in FootyCollect
- [Architecture Overview](https://docs.footycollect.sunr4y.dev/architecture/overview.md): High-level overview of FootyCollect's technical architecture and design patterns
- [Service Layer Pattern](https://docs.footycollect.sunr4y.dev/architecture/service-layer.md): Service layer architecture for encapsulating business logic in FootyCollect
- [cleanup_orphaned_photos](https://docs.footycollect.sunr4y.dev/commands/cleanup-orphaned-photos.md): Remove orphaned photo files from storage
- [fetch_home_kits](https://docs.footycollect.sunr4y.dev/commands/fetch-home-kits.md): Fetch and cache kits for homepage display from FKAPI
- [migrate_photos_to_remote](https://docs.footycollect.sunr4y.dev/commands/migrate-photos-to-remote.md): Migrate photos from local storage to remote storage (S3/R2)
- [Management commands overview](https://docs.footycollect.sunr4y.dev/commands/overview.md): Django management commands for FootyCollect maintenance and operations
- [populate_user_collection](https://docs.footycollect.sunr4y.dev/commands/populate-collection.md): Bulk import collections from Football Kit Archive API
- [setup_beat_schedule](https://docs.footycollect.sunr4y.dev/commands/setup-beat-schedule.md): Configure periodic Celery tasks for automatic maintenance
- [Live demo](https://docs.footycollect.sunr4y.dev/demo.md): Try FootyCollect without installing anything
- [Bare Metal VPS Deployment](https://docs.footycollect.sunr4y.dev/deployment/bare-metal.md): Deploy FootyCollect on Ubuntu/Debian servers with Nginx and Gunicorn
- [Docker Production Deployment](https://docs.footycollect.sunr4y.dev/deployment/docker-production.md): Deploy FootyCollect with Docker Compose for a complete production stack
- [Production Environment Setup](https://docs.footycollect.sunr4y.dev/deployment/environment-setup.md): Configure production environment variables and secrets for FootyCollect
- [Deployment Overview](https://docs.footycollect.sunr4y.dev/deployment/overview.md): Deploy FootyCollect to production using Docker or bare metal VPS
- [Production Checklist](https://docs.footycollect.sunr4y.dev/deployment/production-checklist.md): Pre-deployment security and configuration checklist for FootyCollect
- [Celery Tasks](https://docs.footycollect.sunr4y.dev/development/celery-tasks.md): Background task processing with Celery in FootyCollect
- [Code Quality](https://docs.footycollect.sunr4y.dev/development/code-quality.md): Code quality tools, standards, and linting for FootyCollect
- [Project Structure](https://docs.footycollect.sunr4y.dev/development/project-structure.md): Understanding the FootyCollect codebase organization
- [Running Tests](https://docs.footycollect.sunr4y.dev/development/running-tests.md): Guide to running and writing tests for FootyCollect
- [Collection Management](https://docs.footycollect.sunr4y.dev/features/collection-management.md): Organize and manage your football memorabilia collection with multiple item types and powerful organization features
- [FKAPI Integration](https://docs.footycollect.sunr4y.dev/features/fkapi-integration.md): Search and add kits from the Football Kit Archive with automatic metadata population using the FKAPI service
- [Photo Management](https://docs.footycollect.sunr4y.dev/features/photo-management.md): Upload, optimize, and organize photos for your football memorabilia with automatic AVIF conversion and smart thumbnail generation
- [Search & Filters](https://docs.footycollect.sunr4y.dev/features/search-and-filters.md): Powerful search and filtering capabilities to find items in your collection quickly and efficiently
- [User Profiles](https://docs.footycollect.sunr4y.dev/features/user-profiles.md): Customize your profile, control privacy settings, and manage collection visibility in FootyCollect
- [Adding Items to Your Collection](https://docs.footycollect.sunr4y.dev/guide/adding-items.md): Learn how to add football memorabilia to your FootyCollect collection using FKAPI search or manual entry
- [Managing Photos](https://docs.footycollect.sunr4y.dev/guide/managing-photos.md): Upload, organize, and optimize photos for your football memorabilia collection
- [Privacy Settings](https://docs.footycollect.sunr4y.dev/guide/privacy-settings.md): Control the visibility of your collection and profile in FootyCollect
- [Searching and Browsing Collections](https://docs.footycollect.sunr4y.dev/guide/searching-collections.md): Find items in your FootyCollect collection using filters, search, and advanced queries
- [Docker Development Setup](https://docs.footycollect.sunr4y.dev/installation/docker-setup.md): Run FootyCollect with Docker Compose for a complete development environment
- [Environment Variables](https://docs.footycollect.sunr4y.dev/installation/environment-variables.md): Complete reference for all FootyCollect configuration options
- [Local Development Setup](https://docs.footycollect.sunr4y.dev/installation/local-setup.md): Set up FootyCollect for local development with Python, PostgreSQL, and Redis
- [Introduction](https://docs.footycollect.sunr4y.dev/introduction.md): A Django-based web application for managing your football memorabilia collection
- [Quickstart](https://docs.footycollect.sunr4y.dev/quickstart.md): Get FootyCollect running and create your first collection item