nottit

A progressive web app and client for Reddit with authenticated logins via the reddit API and a variety of browsing options based on Troddit. It also

Features

• No trackers like those on reddit.com
• No ads.... like no effing ads, that was the whole point of this.
• Secure by design with constantly updated packages and dependencies, this is specifically security focused, therefore functionality may be lost in the interest of security due to breaking changes in package updates.
• Simple to deploy and host yourself if you're of the super paranoid variety (you're on reddit so probably)
• 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 multiredditss locally without login. Autogenerates a personal front page.
  • Visit your multireddit and copy the multireddit link. Replace 'reddit' with 'nottit' 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 the 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

Deploying

Environment Variables

To use login functionality the following environment variables need to be defined in your compose file, cloud host settings or a .env.local file placed in the root directory for non docker deployments:

CLIENT_ID=<ID of your Reddit app>
CLIENT_SECRET=<Secret from your Reddit app>
REDDIT_REDIRECT=http://localhost:3000/api/auth/callback/reddit
NEXTAUTH_SECRET=<See https://next-auth.js.org/configuration/options#secret>
NEXTAUTH_URL=http://localhost:3000

Docker

To Deploy the Docker Image

docker pull gyarbij/nottit
docker run -d --name nottit -p 3000:3000 gyarbij/nottit

Alternatively for arm64:

docker pull gyarbij/nottit:arm64

Deploy as an Azure Web App

To deploy as an azure web app, always use the :latest tag or specify :amd64 as the arm64 image will not run on the linux ASP!

gyarbij/nottit:latest

Alternatively specify amd64:

gyarbij/nottit:amd64

Enter the environment variables in

YourWebApp > Settings > Configuration > Application settings

Deploy as an AWS Lightsale Container

To deploy on lightsail, always use the <:latest tag> or specify <:amd64>

Additionally, open port 3000 in the deployment setup

Ensure to select the nottit container as the public endpoint!

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.

git clone https://github.com/gyarbij/nottit
cd nottit
docker build . -t nottit

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

docker run -p 3000:3000 nottit

Developing/Running without Docker

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=http://localhost:3000/api/auth/callback/reddit
NEXTAUTH_SECRET=<See https://next-auth.js.org/configuration/options#secret>
NEXTAUTH_URL=http://localhost:3000

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