teddit-reddit-frontend-alte.../README.md

93 lines
2.8 KiB
Markdown
Raw Normal View History

2020-11-17 21:44:32 +01:00
# teddit
2020-11-17 22:02:20 +01:00
[teddit.net](https://teddit.net)
2020-11-17 21:44:32 +01:00
A free and open source alternative Reddit front-end focused on privacy.
Inspired by the [Nitter](https://github.com/zedeus/nitter) project.
* No JavaScript or ads
* All requests go through the backend, client never talks to Reddit
* Prevents Reddit from tracking your IP or JavaScript fingerprint
2021-01-06 16:23:49 +01:00
* [Unofficial API](https://codeberg.org/teddit/teddit/wiki#teddit-api) (RSS & JSON support, no rate limits or Reddit account required)
2020-11-17 21:44:32 +01:00
* Lightweight (teddit frontpage: ~30 HTTP requests with ~270 KB of data downloaded vs. Reddit frontpage: ~190 requests with ~24 MB)
* Self-hostable. Anyone can setup an instance. An instance can either use Reddit's API with or without OAuth (so Reddit API key is not necessarily needed).
2020-11-17 21:44:32 +01:00
2020-11-29 13:03:06 +01:00
Join the teddit discussion room on Matrix: [#teddit:matrix.org](https://matrix.to/#/#teddit:matrix.org)
2020-11-19 06:55:25 +01:00
2020-11-17 21:44:32 +01:00
XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj
2020-11-17 21:57:40 +01:00
2020-12-01 16:16:30 +01:00
## Instances
[https://teddit.net](https://teddit.net) - Official instance
Community instances:
* [https://teddit.ggc-project.de](https://teddit.ggc-project.de)
2020-12-27 15:46:07 +01:00
* [https://teddit.kavin.rocks](https://teddit.kavin.rocks)
2021-01-29 16:26:06 +01:00
* [https://teddit.zaggy.nl](https://teddit.zaggy.nl)
2021-02-09 15:48:41 +01:00
* [https://teddit.namazso.eu/](https://teddit.namazso.eu/)
2021-02-27 19:49:54 +01:00
* [https://teddit.nautolan.racing](https://teddit.nautolan.racing)
2021-03-18 20:00:41 +01:00
* [https://teddit.tinfoil-hat.net](https://teddit.tinfoil-hat.net)
* [ibarajztopxnuhabfu7f...onion](http://ibarajztopxnuhabfu7fg6gbudynxofbnmvis3ltj6lfx47b6fhrd5qd.onion)
* [xugoqcf2pftm76vbznx4...i2p](http://xugoqcf2pftm76vbznx4xuhrzyb5b6zwpizpnw2hysexjdn5l2tq.b32.i2p)
2021-02-27 19:49:54 +01:00
## TODO
* User trophies
* "other discussions" feature
2020-12-04 17:11:02 +01:00
* "Open on reddit" links
* ... and lot of other small stuff
## Roadmap
* HLS video streaming? (Would require browser JavaScript)
* User login, so people can use their Reddit account through teddit to comment and up/downvote posts etc.
2021-01-19 18:51:11 +01:00
## Changelog
2021-01-19 18:51:11 +01:00
See ```CHANGELOG.md```
2020-11-17 21:44:32 +01:00
## Installation
2020-11-17 21:57:40 +01:00
### Docker
Using [Docker and `docker-compose`](https://github.com/docker/compose):
```console
docker-compose build
docker-compose up
```
2020-12-10 23:18:18 +01:00
Teddit should now be running at <http://localhost:8080>.
### Manual
1. Install [Node.js](https://nodejs.org).
2020-12-10 23:18:18 +01:00
1. (Optional) Install [redis-server](https://redis.io).
Highly recommended  it works as a cache for Reddit API calls.
2020-12-10 23:18:18 +01:00
1. (Optional) Install [ffmpeg](https://ffmpeg.org).
It's needed if you want to support videos.
```console
# Linux
apt install redis-server ffmpeg
# macOS
brew install redis
```
1. Clone and set up the repository.
2020-11-17 21:57:40 +01:00
```console
git clone https://codeberg.org/teddit/teddit
cd teddit
npm install --no-optional
cp config.js.template config.js # edit the file to suit your environment
redis-server
npm start
```
2020-12-03 18:29:03 +01:00
2020-12-10 23:18:18 +01:00
Teddit should now be running at <http://localhost:8080>.