1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-22 16:17:29 +00:00
bibliogram/README.md

64 lines
1.5 KiB
Markdown
Raw Normal View History

2020-01-12 12:50:21 +00:00
# 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)
## Features
- [x] View profile and timeline
2020-01-12 15:39:50 +00:00
- [x] Infinite scroll
2020-01-12 12:50:21 +00:00
- [x] User memory cache
2020-01-14 14:44:45 +00:00
- [x] RSS (latest 12 posts)
2020-01-12 12:50:21 +00:00
- [ ] Image disk cache
- [ ] View post
- [ ] Homepage
2020-01-14 14:44:45 +00:00
- [ ] Proper error checking
2020-01-12 12:50:21 +00:00
- [ ] Optimised for mobile
- [ ] Favicon
- [ ] Settings (e.g. data saving)
- [ ] Galleries
- [ ] List view
- [ ] Videos
- [ ] IGTV
- [ ] Public API
- [ ] Rate limiting
- [ ] Explore tags
- [ ] Explore locations
- [ ] _more..._
These features may not be able to be implemented for technical reasons:
- Stories
These features will not be added:
- Comments
## Instances
There is currently no official Bibliogram instance. You will have to run your own, or find someone else's.
If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost.
## Installing
2020-01-14 14:44:45 +00:00
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`
2020-01-12 12:50:21 +00:00
Bibliogram is now running on `0.0.0.0:10407`.
## User-facing endpoints
- `/u/{username}` - load a user's profile and timeline
2020-01-14 14:44:45 +00:00
- `/u/{username}/rss.xml` - get the RSS feed for a user