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

93 lines
2.8 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# teddit
[teddit.net](https://teddit.net)
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
* [Unofficial API](https://codeberg.org/teddit/teddit/wiki#teddit-api) (RSS & JSON support, no rate limits or Reddit account required)
* 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).
Join the teddit discussion room on Matrix: [#teddit:matrix.org](https://matrix.to/#/#teddit:matrix.org)
XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj
## Instances
[https://teddit.net](https://teddit.net) - Official instance
Community instances:
* [https://teddit.ggc-project.de](https://teddit.ggc-project.de)
* [https://teddit.kavin.rocks](https://teddit.kavin.rocks)
* [https://teddit.zaggy.nl](https://teddit.zaggy.nl)
* [https://teddit.namazso.eu/](https://teddit.namazso.eu/)
* [https://teddit.nautolan.racing](https://teddit.nautolan.racing)
* [https://teddit.tinfoil-hat.net](https://teddit.tinfoil-hat.net)
* [ibarajztopxnuhabfu7f...onion](http://ibarajztopxnuhabfu7fg6gbudynxofbnmvis3ltj6lfx47b6fhrd5qd.onion)
* [xugoqcf2pftm76vbznx4...i2p](http://xugoqcf2pftm76vbznx4xuhrzyb5b6zwpizpnw2hysexjdn5l2tq.b32.i2p)
## TODO
* User trophies
* "other discussions" feature
* "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.
## Changelog
See ```CHANGELOG.md```
## Installation
### Docker
Using [Docker and `docker-compose`](https://github.com/docker/compose):
```console
docker-compose build
docker-compose up
```
Teddit should now be running at <http://localhost:8080>.
### Manual
1. Install [Node.js](https://nodejs.org).
1. (Optional) Install [redis-server](https://redis.io).
Highly recommended  it works as a cache for Reddit API calls.
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.
```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
```
Teddit should now be running at <http://localhost:8080>.