{"id":13594890,"url":"https://github.com/burhan-syed/troddit","last_synced_at":"2025-04-09T10:32:15.421Z","repository":{"id":36985999,"uuid":"389229514","full_name":"burhan-syed/troddit","owner":"burhan-syed","description":"A web client for Reddit with authenticated logins and a variety of browsing options","archived":false,"fork":false,"pushed_at":"2024-02-14T03:48:08.000Z","size":2593,"stargazers_count":566,"open_issues_count":39,"forks_count":82,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-11-06T17:43:14.461Z","etag":null,"topics":["nextjs","react","reddit","tailwindcss"],"latest_commit_sha":null,"homepage":"https://www.troddit.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/burhan-syed.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"troddit"}},"created_at":"2021-07-25T00:56:20.000Z","updated_at":"2024-10-28T00:15:10.000Z","dependencies_parsed_at":"2024-11-06T17:38:30.390Z","dependency_job_id":"c14ca4be-8b98-405f-97a5-547ef75f12e3","html_url":"https://github.com/burhan-syed/troddit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burhan-syed%2Ftroddit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burhan-syed%2Ftroddit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burhan-syed%2Ftroddit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burhan-syed%2Ftroddit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/burhan-syed","download_url":"https://codeload.github.com/burhan-syed/troddit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248020592,"owners_count":21034459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","react","reddit","tailwindcss"],"created_at":"2024-08-01T16:01:40.493Z","updated_at":"2025-04-09T10:32:11.073Z","avatar_url":"https://github.com/burhan-syed.png","language":"TypeScript","funding_links":["https://ko-fi.com/troddit","https://ko-fi.com/K3K47IYH1"],"categories":["TypeScript","Alternative Web Front-ends","Alternative Frontends","Overview"],"sub_categories":["Reddit"],"readme":"# Troddit\n\n### _An alternative front end web client for Reddit_\n\nLive at [troddit.com](https://www.troddit.com)\n\n## Screenshots\n\n### Flexible column viewing.\n\nShown browsing a multi-reddit. Subreddits pane and options menu open.\n\u003cimg width=\"1725\" alt=\"columns_options\" src=\"https://user-images.githubusercontent.com/32972409/155919206-e7256397-b2a7-4718-bd17-ff1982b56d1a.png\"\u003e\n\n### Classic rows view\n\n\u003cimg width=\"1725\" alt=\"classicrows_light\" src=\"https://user-images.githubusercontent.com/32972409/155919273-1f5ba3ef-5f4f-45ec-a12b-ea3e5847e24c.png\"\u003e\n\n#### with inline media expansion and custom reddit video player\n\n\u003cimg width=\"1725\" alt=\"lightmode_row_open\" src=\"https://user-images.githubusercontent.com/32972409/155919303-ec87bc67-bd2b-4cb5-b2c1-21456bf509df.png\"\u003e\n\n### Open posts with comments to the side and use arrows for navigation\n\n\u003cimg width=\"1725\" alt=\"post_open\" src=\"https://user-images.githubusercontent.com/32972409/155919310-0d57fdaa-03a0-47c0-be03-1c29da6e87ac.png\"\u003e\n\n### Search for subreddits, users, and posts.\n\nShown in single column mode with wide UI disabled. Sort options menu is open.\n\u003cimg width=\"1724\" alt=\"search_narrow\" src=\"https://user-images.githubusercontent.com/32972409/155919321-7dd78a3b-5eac-4753-92f9-295d44447e17.png\"\u003e\n\n### Fully responsive, downloadable as PWA\n\n\u003cimg width=\"377\" alt=\"responsive_troddit\" src=\"https://user-images.githubusercontent.com/32972409/155920807-d6be76a6-c5e6-4f2a-b899-4910d7ca3801.png\"\u003e\n\n## Features\n\n- Secure logins with Reddit to enable voting, commenting, managing your subreddits and multireddits (aka feeds), and access to your personal front page.\n- 'Offline mode' to follow subreddits and manage multis locally without login. Autogenerates a personal front page.\n  - 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.\n- Search Reddit for posts or subreddits quickly with auto-complete.\n- Filter posts by type (Images, Video/GIFs, Links, Self)\n- View posts in single column, custom multi-column with a grid-masonry layout, or a simple row mode. All with infinite-scrolling.\n- 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.\n- 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.\n- 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.\n- Responsive desktop and mobile layouts.\n- PWA to download to your computer or phone.\n- Docker support\n\n## Developing\n\nClone the repo and install all packages with npm or yarn. Then to run development server:\n\n```sh\nnpm run dev\n# or\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\nTo contribute create a branch and submit a PR!\n\n### Environment Variables\n\nTo use login functionality the following environment variables need to be defined in a .env.local file placed in the root directory:\n\n```sh\nCLIENT_ID=\u003cID of your Reddit app\u003e\nCLIENT_SECRET=\u003cSecret from your Reddit app\u003e\nREDDIT_REDIRECT=\u003cYOUR DOMAIN/api/auth/callback/reddit\u003e\nNEXTAUTH_SECRET=\u003cSee https://next-auth.js.org/configuration/options#secret\u003e\nNEXTAUTH_URL=http://localhost:3000\nSIGNING_PRIVATE_KEY=\u003cSee https://next-auth.js.org/v3/warnings, Generate with $jose newkey -s 256 -t oct -a HS512\u003e\n```\n\nTo create a Reddit app visit [https://old.reddit.com/prefs/apps/](https://old.reddit.com/prefs/apps/).\nThe redirect uri should match the REDDIT_REDIRECT variable.\n\n## Docker\n\n### To Deploy the [Docker Image](https://hub.docker.com/r/bsyed/troddit)\n\n```sh\ndocker pull bsyed/troddit\ndocker run -d --name troddit -p 3000:3000 bsyed/troddit\n```\n\n### To Build the Image Yourself\n\nBy default, the Docker will expose port 3000, so change this within the\nDockerfile if necessary. When ready, simply use the Dockerfile to\nbuild the image.\n\nClone and navigate to the repository \n\n```sh\ngit clone https://github.com/burhan-syed/troddit\ncd troddit\n```\n\nTo build the image and run container\n\n```sh\ndocker-compose up\n```\n\nOr to just build\n\n```sh\ndocker build . -t troddit\n```\n\nThis will create the troddit image and pull in the necessary dependencies. To run:\n\n```sh\ndocker run -p 3000:3000 troddit\n```\n\n### Support\n\nIf you like the project feel free to share and leave a star. If you're feeling generous you can support me on Ko-fi.\n\n\u003cspan align=\"center\"\u003e[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K47IYH1)\u003c/span\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburhan-syed%2Ftroddit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fburhan-syed%2Ftroddit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburhan-syed%2Ftroddit/lists"}