teddit/README.md
2020-12-27 15:46:07 +01:00

2.3 KiB
Raw Blame History

teddit

teddit.net

A free and open source alternative Reddit front-end focused on privacy. Inspired by the 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 (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)

Join the teddit discussion room on Matrix: #teddit:matrix.org

XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj

BTC: bc1qlcrmt2pvlh4eq69l3l4h6z5jg74z2m2q3pasan

Instances

https://teddit.net - Official instance

Community instances:

TODO

  • Subreddit wikis
  • User trophies
  • “other discussions” feature
  • “Open on reddit” links
  • … and lot of other small stuff

Roadmap

  • More themes, not just white or dark
  • HLS video streaming? (Would require browser JavaScript)
  • Onion site
  • User login, so people can use their Reddit account through teddit to comment and up/downvote posts etc.

Installation

Docker

Using Docker and docker-compose:

docker-compose build
docker-compose up

Teddit should now be running at http://localhost:8080.

Manual

  1. Install Node.js.

  2. (Optional) Install redis-server.

    Highly recommended  it works as a cache for Reddit API calls.

  3. (Optional) Install ffmpeg.

    Its needed if you want to support videos.

    # Linux
    apt install redis-server ffmpeg
    
    # macOS
    brew install redis
  4. Clone and set up the repository.

    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.