1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-22 16:17:29 +00:00
bibliogram/README.md
2020-01-27 04:34:10 +13:00

78 lines
2.1 KiB
Markdown

# 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.](https://github.com/omarroth/invidious)
Join the Bibliogram discussion room on Matrix: [#bibliogram:matrix.org](https://riot.im/app/#/room/#bibliogram:matrix.org)
## Features
- [x] View profile and timeline
- [x] Infinite scroll
- [x] User memory cache
- [x] RSS (latest 12 posts)
- [x] View post
- [x] Galleries
- [ ] Videos
- [ ] Galleries of videos
- [ ] Image disk cache
- [ ] Clickable usernames and hashtags
- [ ] Homepage
- [ ] 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
There is currently no official Bibliogram instance, but there will be in the future.
For now, you can see a list of instances created by the community [on the wiki page](https://github.com/cloudrac3r/bibliogram/wiki).
If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost.
## Installing
Bibliogram depends on GraphicsMagick for resizing thumbnails.
Ubuntu: `# apt install graphicsmagick`
1. `$ git clone https://github.com/cloudrac3r/bibliogram`
If you are using a fork, be sure to actually install that fork instead!
1. `$ npm install`
1. Edit `/config.js` to suit your server environment
1. `$ npm start`
Bibliogram is now running on `0.0.0.0:10407`.
## User-facing endpoints
- `/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