Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/burhan-syed/troddit
A web client for Reddit with authenticated logins and a variety of browsing options
https://github.com/burhan-syed/troddit
nextjs react reddit tailwindcss
Last synced: about 1 month ago
JSON representation
A web client for Reddit with authenticated logins and a variety of browsing options
- Host: GitHub
- URL: https://github.com/burhan-syed/troddit
- Owner: burhan-syed
- License: agpl-3.0
- Created: 2021-07-25T00:56:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T03:48:08.000Z (10 months ago)
- Last Synced: 2024-08-02T16:54:39.780Z (4 months ago)
- Topics: nextjs, react, reddit, tailwindcss
- Language: TypeScript
- Homepage: https://www.troddit.com
- Size: 2.47 MB
- Stars: 542
- Watchers: 11
- Forks: 79
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- alternative-frontends - x
- alternative-front-ends - Troddit
- alternative-frontends - x
README
# Troddit
### _An alternative front end web client for Reddit_
Live at [troddit.com](https://www.troddit.com)
## Screenshots
### Flexible column viewing.
Shown browsing a multi-reddit. Subreddits pane and options menu open.
### Classic rows view
#### with inline media expansion and custom reddit video player
### Open posts with comments to the side and use arrows for navigation
### Search for subreddits, users, and posts.
Shown in single column mode with wide UI disabled. Sort options menu is open.
### Fully responsive, downloadable as PWA
## Features
- Secure logins with Reddit to enable voting, commenting, managing your subreddits and multireddits (aka feeds), and access to your personal front page.
- 'Offline mode' to follow subreddits and manage multis locally without login. Autogenerates a personal front page.
- Visit your [subreddits multi](https://www.reddit.com/subreddits) and copy the multireddit link. Replace 'reddit' with 'troddit' in the URL and then use the 'Join All' option to quickly follow all subs locally.
- Search Reddit for posts or subreddits quickly with auto-complete.
- Filter posts by type (Images, Video/GIFs, Links, Self)
- View posts in single column, custom multi-column with a grid-masonry layout, or a simple row mode. All with infinite-scrolling.
- Choose your card style: Original for full post text in card, Compact to exclude post text, or Media to hide all text and card padding.
- Gallery view: Click on a post and navigate through the feed with on screen buttons or your arrow keys. Shows the post content as well as its comments from Reddit. Smart portrait mode to automatically arrange vertical photos and videos side by side with comments.
- Hover mouse over Reddit videos to play. Enable to Autoplay option to play videos automatically when entering the viewport. Enable the Audio option to play sound on hover as well.
- Responsive desktop and mobile layouts.
- PWA to download to your computer or phone.
- Docker support
## Developing
Clone the repo and install all packages with npm or yarn. Then to run development server:
```sh
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](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:
```sh
CLIENT_ID=
CLIENT_SECRET=
REDDIT_REDIRECT=
NEXTAUTH_SECRET=
NEXTAUTH_URL=http://localhost:3000
SIGNING_PRIVATE_KEY=
```
To create a Reddit app visit [https://old.reddit.com/prefs/apps/](https://old.reddit.com/prefs/apps/).
The redirect uri should match the REDDIT_REDIRECT variable.
## Docker
### To Deploy the [Docker Image](https://hub.docker.com/r/bsyed/troddit)
```sh
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
```sh
git clone https://github.com/burhan-syed/troddit
cd troddit
```
To build the image and run container
```sh
docker-compose up
```
Or to just build
```sh
docker build . -t troddit
```
This will create the troddit image and pull in the necessary dependencies. To run:
```sh
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.
[](https://ko-fi.com/K3K47IYH1)