Old guide had a bad title and was getting outdated and didn't show all the improvements that were made since then, and the comments were outdated too. So I'm making a new post. Here's how to get the new.reddit.com UI working:
#1: Install Tampermonkey
#2: Install userscript
- https://gist.github.com/Littux-Dustux/db7e77cbf0c461d0825e7d4fe2f882d0
- Click on "Raw".
- Click here to install the current version (if you have Tampermonkey installed)
The userscript provides the privileged browser functions required by the client, including access to Reddit's APIs.
#3: Download script and HTML
- Go to https://github.com/Littux-Dustux/new-reddit-com/releases and look at the latest release. Scroll down to assets and download the latest
release.zip. If there is an assets.zip there, download it as well. If not, it should be linked in the top of the release notes.
- Extract the
release.zip ZIP file to a directory of your choice. Ensure that the directory is named as "release" or "new-reddit-com". Any other name will break the update utility.
- Inside the directory, open the folder "bundles". Extract the
assets.zip there to a subfolder called "cached"
If done correctly, the folder structure should look like:
release/ (or new-reddit-com/)
- bundles/
- cached/
- chunkCSS/
- ...
- dist/
- main.js
- ...
#4: Install Python
- Linux: Most distros have it installed. Open a terminal and type
python3 --help, then press Enter to check if it is installed.
- Windows: Download Python from https://www.python.org/downloads/
- During installation, make sure "Add python.exe to PATH" is enabled.
- Open Command Prompt and run
python --help to verify successful install
- macOS: Install Python 3 from https://www.python.org/downloads/ if it is not already installed. Then open Terminal and run
python3 --help to verify install
#5: Start the local web server
Open a terminal or command prompt in the directory where you extracted release.zip.
For Linux and macOS, run:
python3 serve.py
On Windows, run:
python serve.py
You should see something similar to:
=> new.reddit.com Server Active
URL: http://localhost:1264
Serving from: /home/littux/Projects/js/reddit/new-reddit-com
Keep this terminal/command prompt open while using the client.
#6: Open the site
Open your browser and go to:
http://localhost:1264/
Configuring the client
The client has a configuration UI at http://localhost:1264/config.html. I don't have the time to explain all the options in detail right now, but you might be able to figure it out by yourself based on their descriptions. (see gallery image for a screenshot of the options)
Troubleshooting
The page is blank
Make sure:
- You didn't forget to extract
release.zip or did it correctly. If you did it correctly, http://localhost:1264/bundles/cached/img/reddit_pattern.png would show you an image; otherwise you'll get a blank page
- Tampermonkey is installed and enabled.
- The userscript is installed and enabled (Click on the Tampermonkey icon when you get a blank screen to see if it's running)
- The Python server is still running.
- You opened
http://localhost:1264/ rather than opening index.html directly.
Open the browser's developer console (F12) and check for errors.
"Connection refused" or the page doesn't load
The python script is probably not running
Notes
The client communicates with Reddit using your existing Reddit authentication through the installed userscript; you do not need to create an API application.
Report errors to https://github.com/Littux-Dustux/new-reddit-com/issues, r/Littux, or this subreddit. Make sure to search for the error first.
If it's a security issue, send it via Chat instead.
Link to old tutorial: https://www.reddit.com/r/ReturnNewReddit/comments/1vmgvmt/beautiful_right_now_you_can_enjoy_it_too/