burhan-syed / troddit

A web client for Reddit with authenticated logins and a variety of browsing options
https://www.troddit.com
GNU Affero General Public License v3.0
551 stars 80 forks source link
nextjs react reddit tailwindcss

Troddit

An alternative front end web client for Reddit

Live at troddit.com

Screenshots

Flexible column viewing.

Shown browsing a multi-reddit. Subreddits pane and options menu open.

columns_options

Classic rows view

classicrows_light

with inline media expansion and custom reddit video player

lightmode_row_open

Open posts with comments to the side and use arrows for navigation

post_open

Search for subreddits, users, and posts.

Shown in single column mode with wide UI disabled. Sort options menu is open.

search_narrow

Fully responsive, downloadable as PWA

responsive_troddit

Features

Developing

Clone the repo and install all packages with npm or yarn. Then to run development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

To contribute create a branch and submit a PR!

Environment Variables

To use login functionality the following environment variables need to be defined in a .env.local file placed in the root directory:

CLIENT_ID=<ID of your Reddit app>
CLIENT_SECRET=<Secret from your Reddit app>
REDDIT_REDIRECT=<YOUR DOMAIN/api/auth/callback/reddit>
NEXTAUTH_SECRET=<See https://next-auth.js.org/configuration/options#secret>
NEXTAUTH_URL=http://localhost:3000
SIGNING_PRIVATE_KEY=<See https://next-auth.js.org/v3/warnings, Generate with $jose newkey -s 256 -t oct -a HS512>

To create a Reddit app visit https://old.reddit.com/prefs/apps/. The redirect uri should match the REDDIT_REDIRECT variable.

Docker

To Deploy the Docker Image

docker pull bsyed/troddit
docker run -d --name troddit -p 3000:3000 bsyed/troddit

To Build the Image Yourself

By default, the Docker will expose port 3000, so change this within the Dockerfile if necessary. When ready, simply use the Dockerfile to build the image.

Clone and navigate to the repository

git clone https://github.com/burhan-syed/troddit
cd troddit

To build the image and run container

docker-compose up

Or to just build

docker build . -t troddit

This will create the troddit image and pull in the necessary dependencies. To run:

docker run -p 3000:3000 troddit

Support

If you like the project feel free to share and leave a star. If you're feeling generous you can support me on Ko-fi.

ko-fi