PixelPunk  by CooperJiang

Intelligent image hosting and resource management platform

Created 8 months ago
418 stars

Top 70.2% on SourcePulse

GitHubView on GitHub
Project Summary

This project offers a full-stack intelligent image hosting and resource management platform designed to simplify image handling and accelerate file sharing. It targets users seeking a modern, feature-rich solution with integrated AI capabilities for enhanced organization and search, providing a more efficient alternative to traditional file hosting services.

How It Works

PixelPunk employs a robust architecture combining Go (1.24+) for the backend (Gin, GORM) and Vue 3 for the frontend. It leverages AI, compatible with OpenAI APIs, for automated image classification, tagging, semantic parsing, and NSFW detection. Core functionalities are supported by Redis for caching and optionally Qdrant for advanced vector search, enabling image-to-image and semantic similarity searches.

Quick Start & Requirements

  • Primary Install:
    • One-Click Installer: curl -fsSL http://download.pixelpunk.cc/shell/setup.sh | bash
    • Docker: docker pull snine98/pixelpunk:latest followed by curl -O https://download.pixelpunk.cc/docker/docker-compose.yml and docker-compose up -d.
  • Prerequisites:
    • OS: Linux (x86_64/ARM64), macOS (Intel/Apple Silicon), Windows (WSL2).
    • Dependencies (auto-installed in Docker): MySQL 5.7+ / SQLite 3.x, Redis 6.0+, Qdrant 1.11+ (optional), OpenAI API or compatible (optional).
    • Minimum Configuration: 2 cores CPU, 2GB RAM, 10GB disk space.
    • Recommended Configuration: 4+ cores CPU, 4GB+ RAM, 50GB+ SSD.
  • Links: Official Website, Live Demo

Highlighted Details

  • AI Automation: Features auto image classification, tagging, semantic parsing, and NSFW detection using OpenAI compatible APIs.
  • Vector Search: Integrates Qdrant for powerful image-to-image and semantic similarity search capabilities.
  • Comprehensive Feature Set: Includes multi-format uploads, custom watermarks, expiration settings, advanced file management, natural language search, flexible sharing, robust access control, and an open API.
  • Deployment Flexibility: Supports single binary deployment, Docker containerization, and cross-platform compatibility.

Maintenance & Community

The project indicates active development through its "Upcoming Features" list. However, the README does not provide details on specific maintainers, sponsorships, or community channels like Discord or Slack.

Licensing & Compatibility

  • License: PolyForm Noncommercial License 1.0.0.
  • Compatibility: Permitted for personal use, learning, and research. Commercial use is strictly prohibited without explicit authorization.

Limitations & Caveats

The PolyForm Noncommercial License severely restricts commercial adoption. AI and vector search functionalities are optional, requiring external API keys (OpenAI) and database setups (Qdrant), which may introduce additional costs and complexity. The project is actively under development, with several features listed as upcoming.

Health Check
Last Commit

1 month ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
3
Star History
55 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.