Skip to content

README.md

Latest commit

 

History

History
60 lines (37 loc) · 2.25 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.25 KB

Comps

Build Status Docker Image Version License: GPL v3 Security Status

Comps is a open source self hostable version of Slowpoke Pics. A web-based tool for comparing multiple images side by side.

Tots not vibe coded because lazy

Features

  • Upload multiple images for side-by-side comparison
  • Navigate between images using keyboard shortcuts or UI controls
  • Add metadata like comparison name, show name, and tags
  • Fit-to-screen and original size viewing modes
  • Border toggle for better image separation
  • Responsive design for different screen sizes
  • Docker support for easy deployment

Installation

Using Docker (Recommended)

  1. Clone the repository:

API Documentation

Comps provides a RESTful API for programmatic access:

For more details, see the API Documentation.

Database backends

Comps supports both SQLite (default) and PostgreSQL.

  • SQLite (default): set DB_PATH to the SQLite file path (default: comparisons.db)
  • PostgreSQL: set DB_BACKEND=postgres and provide DATABASE_URL (or DB_URL) like:
    • postgresql://user:pass@host:5432/dbname

Migrations run automatically at startup for the selected backend.

Docker Compose example (PostgreSQL)

Use the provided docker-compose.postgres.yml:

docker compose -f docker-compose.postgres.yml up -d --build

This spins up Postgres and the app with DB_BACKEND=postgres and DATABASE_URL set, waits for Postgres to be healthy, then starts the app. The app’s entrypoint blocks until migrations initialize.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Third-Party Code

This project includes code from EasyCompare (Copyright (C) 2020 N3xusHD, Sec-ant) licensed under GPL-3.0.