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

# 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
* 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](https://matrix.to/#/#teddit:matrix.org)

XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj

BTC: bc1qlcrmt2pvlh4eq69l3l4h6z5jg74z2m2q3pasan

## Instances

[https://teddit.net](https://teddit.net) - Official instance

Community instances:

* [https://teddit.ggc-project.de](https://teddit.ggc-project.de)

## TODO

* Sort comments in post
* User attributes
* Comment and post attributes (e.g. stickies)
* Subreddit flairs and wikis
* User trophies
* "other discussions" feature
* "Open on reddit" links
* ... and lot of other small stuff

## Roadmap

* Unofficial reddit API through teddit
* Themes
* User settings
* 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

1. Install [node.js](https://nodejs.org/en/)
1. It's highly recommended that you install [redis-server](https://redis.io/) because it works as a cache for Reddit API calls. If you want to support videos, install [ffmpeg](https://ffmpeg.org/)\
For example:\
`# apt install redis-server ffmpeg`
1. `$ git clone https://codeberg.org/teddit/teddit`
1. `$ cd teddit`
1. `$ npm install --no-optional`
1. Copy `config.js.template` to `config.js` and then edit it to suit your environment.
1. `$ npm start`

Teddit should be now running.
initial commit 2020-11-17 21:44:32 +01:00			`# teddit`

add main instance url 2020-11-17 22:02:20 +01:00
			`[teddit.net](https://teddit.net)`


initial commit 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`
			`* Lightweight (teddit frontpage: ~30 HTTP requests with ~270 KB of data downloaded vs. Reddit frontpage: ~190 requests with ~24 MB)`

add matrix chatroom #9 2020-11-29 13:03:06 +01:00			`Join the teddit discussion room on Matrix: [#teddit:matrix.org](https://matrix.to/#/#teddit:matrix.org)`
add notice for alpha version 2020-11-19 06:55:25 +01:00
initial commit 2020-11-17 21:44:32 +01:00			`XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj`
fix README new lines 2020-11-17 21:57:40 +01:00
initial commit 2020-11-17 21:44:32 +01:00			`BTC: bc1qlcrmt2pvlh4eq69l3l4h6z5jg74z2m2q3pasan`

instance info 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)`

add todos, roadmap and simplify the quick installation guide 2020-11-18 18:58:59 +01:00			`## TODO`

			`* Sort comments in post`
			`* User attributes`
			`* Comment and post attributes (e.g. stickies)`
add wikis for todo 2020-11-30 17:06:10 +01:00			`* Subreddit flairs and wikis`
add todos, roadmap and simplify the quick installation guide 2020-11-18 18:58:59 +01:00			`* User trophies`
			`* "other discussions" feature`
add missing redirect_www 2020-12-04 17:11:02 +01:00			`* "Open on reddit" links`
add todos, roadmap and simplify the quick installation guide 2020-11-18 18:58:59 +01:00			`* ... and lot of other small stuff`

			`## Roadmap`

			`* Unofficial reddit API through teddit`
			`* Themes`
			`* User settings`
			`* 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.`

initial commit 2020-11-17 21:44:32 +01:00			`## Installation`
fix README new lines 2020-11-17 21:57:40 +01:00
rm bad command for downloading and installing node.js 2020-12-07 20:03:00 +01:00			`1. Install [node.js](https://nodejs.org/en/)`
add info about redis 2020-12-06 16:08:58 +01:00			`1. It's highly recommended that you install [redis-server](https://redis.io/) because it works as a cache for Reddit API calls. If you want to support videos, install [ffmpeg](https://ffmpeg.org/)\`
fix readme 2020-12-03 18:29:03 +01:00			`For example:\`
rm \ 2020-12-06 16:10:07 +01:00			`# apt install redis-server ffmpeg`
simplify installation 2020-12-03 18:12:04 +01:00			1. `$ git clone https://codeberg.org/teddit/teddit`
			1. `$ cd teddit`
			1. `$ npm install --no-optional`
copy config.js.template instead of overwriting it 2020-12-04 22:57:24 +01:00			1. Copy `config.js.template` to `config.js` and then edit it to suit your environment.
add info about redis 2020-12-06 16:08:58 +01:00			1. `$ npm start`
fix README new lines 2020-11-17 21:57:40 +01:00
add missing redirect_www 2020-12-04 17:11:02 +01:00			`Teddit should be now running.`
fix readme 2020-12-03 18:29:03 +01:00