1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-10-31 21:47:29 +00:00
bibliogram/README.md
Cadence Fish 95cc416e08
Replace GraphicsMagick with sharp
That was easier than I expected.

Closes #18.
2020-01-30 01:14:00 +13:00

2.2 KiB

Bibliogram

An alternative front-end for Instagram.

Bibliogram works without client-side JavaScript, has no ads or tracking, and doesn't urge you to sign up.

See also: Invidious, a front-end for YouTube.

Join the Bibliogram discussion room on Matrix: #bibliogram:matrix.org

Features

  • View profile and timeline
  • Infinite scroll
  • User memory cache
  • RSS (latest 12 posts)
  • View post
  • Galleries
  • Homepage
  • Videos
  • Galleries of videos
  • Image disk cache
  • Clickable usernames and hashtags
  • Instance list
  • Proper error checking
  • Optimised for mobile
  • Favicon
  • Settings (e.g. data saving)
  • List view
  • IGTV
  • Test suite
  • Rate limiting
  • Public API
  • Explore hashtags
  • Explore locations
  • more...

These features may not be able to be implemented for technical reasons:

  • Stories

These features will not be added, unless you ask reallllly nicely:

  • Comments
  • Tagging users

These features will not be added, and I will not investigate adding them:

  • Viewing or interacting with a private profile's timeline

Instances

The official instance is on https://bibliogram.art.

You can see a list of instances run by the community on the wiki page.

If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost.

Installing

You need node.js to run Bibliogram. Versions before 12.13.0 are untested.

  1. $ git clone https://github.com/cloudrac3r/bibliogram
    If you are using a fork, be sure to actually install that fork instead!
  2. $ npm install
  3. Edit /config.js to suit your server environment
  4. $ npm start

Bibliogram is now running on 0.0.0.0:10407.

User-facing endpoints

  • / - homepage
  • /u/{username} - load a user's profile and timeline
  • /u/{username}/rss.xml - get the RSS feed for a user
  • /p/{shortcode} - load a post

Credits

Site banner by TheFrenchGhosty, CC BY-NC-SA 4.0