1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-26 01:37:28 +00:00
bibliogram/README.md

87 lines
2.6 KiB
Markdown
Raw Normal View History

2020-01-28 14:43:48 +00:00
# [Bibliogram](https://bibliogram.art)
2020-01-12 12:50:21 +00:00
## 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)
2020-01-26 15:34:10 +00:00
Join the Bibliogram discussion room on Matrix: [#bibliogram:matrix.org](https://riot.im/app/#/room/#bibliogram:matrix.org)
2020-01-12 12:50:21 +00:00
## 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-18 15:38:14 +00:00
- [x] View post
- [x] Galleries
2020-01-28 10:55:40 +00:00
- [x] Homepage
2020-01-30 12:49:50 +00:00
- [x] Videos
- [x] Galleries of videos
- [x] Optimised for mobile
- [x] Instance list
- [x] Clickable usernames and hashtags
- [x] Proper error checking
2020-01-12 12:50:21 +00:00
- [ ] Image disk cache
- [ ] Favicon
- [ ] Settings (e.g. data saving)
- [ ] List view
- [ ] IGTV
- [ ] Test suite
2020-01-12 12:50:21 +00:00
- [ ] Rate limiting
- [ ] Public API
2020-01-17 14:41:58 +00:00
- [ ] Explore hashtags
2020-01-12 12:50:21 +00:00
- [ ] Explore locations
- [ ] _more...?_
2020-01-12 12:50:21 +00:00
These features may not be able to be implemented for technical reasons:
- Stories
2020-01-17 14:41:58 +00:00
These features will not be added, unless you ask _reallllly_ nicely:
2020-01-12 12:50:21 +00:00
- Comments
2020-01-17 14:41:58 +00:00
- Tagging users
2020-01-12 12:50:21 +00:00
2020-01-26 15:34:10 +00:00
These features will not be added, and I will not investigate adding them:
- Viewing or interacting with a private profile's timeline
2020-01-12 12:50:21 +00:00
## Instances
2020-01-28 14:43:48 +00:00
The official instance is on https://bibliogram.art.
You can see a list of instances run by the community [on the wiki page](https://github.com/cloudrac3r/bibliogram/wiki/Instances).
2020-01-12 12:50:21 +00:00
If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost.
## Installing
Quick setup, if you've run webservers before:
2020-01-14 14:44:45 +00:00
1. Install [node.js](https://nodejs.org/en/) (^12.13.0 suggested)
1. `$ git clone https://github.com/cloudrac3r/bibliogram`
2020-01-14 14:44:45 +00:00
If you are using a fork, be sure to actually install that fork instead!
1. `$ cd bibliogram`
2020-02-02 11:43:56 +00:00
1. `$ npm install --no-optional` (for Tor support, omit `--no-optional`)
2020-01-14 14:44:45 +00:00
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`.
See [Wiki:Installing](https://github.com/cloudrac3r/bibliogram/wiki/Installing) and [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for more details.
2020-01-12 12:50:21 +00:00
## User-facing endpoints
2020-01-28 14:43:48 +00:00
- `/` - homepage
2020-01-12 12:50:21 +00:00
- `/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
2020-02-18 00:39:20 +00:00
- `/u/{username}/atom.xml` - get the Atom feed for a user
2020-01-18 15:38:14 +00:00
- `/p/{shortcode}` - load a post
2020-02-18 00:39:20 +00:00
- `/privacy` - privacy policy
2020-01-28 14:43:48 +00:00
## Credits
Site banner by [TheFrenchGhosty](https://gitlab.com/TheFrenchGhosty), [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)