/mirma.cc-scrapbook-server

mirma.cc scrapbook server, AWS S3 compatible

Primary LanguageTypeScript

Furry site favorite explorer server

This is a simple server that serves your favorites from scraped into the s3 bucket. Submission metadata is stored into the MongoDB database.

Features(with TODOs)

  • Search metadata
  • View submission from local filesystem
  • View submission as proxy
  • View submission by SignedURL

Features not planned

  • Posting submission(s)
  • View comments

Supported sites

Followes the same list as furry-site-favorite-scraper

Querying

Sites is distinguished by the provider field in the submission metadata.

Artist name is tagged as artist:{artist name} tag. Or you can use a dedicated query as username:{artist name} instead.

Installation

  1. Setup

    1. Copy .env.example to .env
    2. Fill in the values
# Image downloaded directory
# Directory structure like thid below:
# ../res
#   |- inkbunny
#   |  |- artist_name
#   |     |- submission_file.jpg
#   |
#   |- furaffinity
#      |- artist_name
#         |- submission_file.jpg
local = "../res"

#[db]
mongodb = "mongodb://localhost:27017"
dbname = "scrapbook"

# If you store your files into the s3 bucket, fill this below
#[s3]
endpoint = "https://s3.us-west-004.backblazeb2.com"
bucket = "my-bucket"
prefix = "prefix/"

#[s3.credentials]
accessKeyId = "AWS access key ID"
secretAccessKey = "AWS secret access key ID"
  1. Install dependencies and run
npm install
npm run build
npm run dev # or npm start

Frameworks

LICENSE

MIT