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

2.9 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 (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

XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj

Instances

https://teddit.net - Official instance

Community instances:

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:

docker-compose build
docker-compose up

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

Docker image is available at https://hub.docker.com/r/teddit/teddit

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.

    It's 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.