Skip to content

Latest commit

 

History

History
executable file
·
123 lines (92 loc) · 8.52 KB

README.md

File metadata and controls

executable file
·
123 lines (92 loc) · 8.52 KB
Raw

RedditJS uses spa-seo-renderer so search engines can crawl this single page app.

RedditJS is now known as js4.red!

RedditJS

The code that powers js4.red.

I rewrote reddit from the ground up using the javascript framework Backbone and the reddit API. I feel that I've created a better user experience as well as additional features that makes for a more enjoyable experience. Follow updates at /r/redditjs.

Features

  • Data Cache: Only have to load up the subreddit once. Once the subreddit is loaded, it will pull the subreddit/single post from memory. (Benefit for both Reddit's server and you! Only fetch once.)
  • Unique Views: View an entire subreddit in a new way. View thumbnails only, full images, and large grid mode. (more to come)
  • Do everything: you normally can on Reddit(*almost everything). Vote/save/hide posts. Comment, Mail, Search all without having to refresh your browser.
  • Bottom Bar: On single post views, you can see a bottom bar that contains all of the posts from that subreddit. If you don't have that subreddit in memory yet, it caches it for later use too. (Faster browsing back to that subreddit in the future). When the bottom bar is not active, it remains at only 20% visibility so you can hardly tell that it's there. I have found that navigating through reddit this way to be more enjoyable.
  • Custom CSS: Subreddit may have custom CSS and flair that goes with them, redditJS uses them!
  • Comment Links: If you hover over a link to an image or Youtube video, it becomes fullsize inside of the comment box. (Future plans to be able to add MEME text to this image right from the image)
  • Permalink Comments: If you visit a link to a permalink of a comment in Reddit it only shows that comment, I've always found this annoying. RedditJS will show that linked comment first and all of the comments from that post in the thread
  • Keyboard Navigation: Use the left and right arrow keys to navigate between posts
  • Subreddit Explorer: I've turned the top left subreddit dropdown menu into a list of subreddits based on category. There are currently about 1,000 subreddits listed here. It helps you discover new subreddits and waste even more time on reddit!
  • Download Images: Download all images and compress them into a zip. Done all on the client side. example
  • Widget embed codes: for reddit posts or subreddits details and examples below.
  • Same Styles everywhere: Option to use the same CSS styles from one subreddit all over reddit. I did this so I could use murica everywhere.
  • Subreddit Slideshow: Create a never ending slideshow from the images in a subreddit. Reddit Slideshow example

RedditJS is built with:

Post embed widget

You can add this script tag to any website. The post widget will embed itself onto your Wordpress post and detect if it has been posted to reddit. details and examples

<script src='//redditjs.com/post.js'></script>

If it has NOT been posted to reddit it will show a link to encourage the user to submit. no reddit post found

If it has been posted, it will load a widget displaying that reddit post giving the user where they can upvote/comment that post.

Post found

This is excellent for websites that have their content submitted to reddit.  It will help increase reddit activity with more upvotes and comments and allow the user to freely navigate reddit.

Instructions

You can add the script tag to any website, or you can use the Reddit Embed Wordpress Plugin to create widgets to embed on your website.

Options
NameDescription values
data-urlThe URL you want to search in reddit to embed on your site, or you can put a reddit post id. For example this post the post id would be 2m2yl7 *defaults to current URL of your website. any url or reddit post id
data-widthWidth of the post widget. number
data-heightHeight of the post widget. number
data-post-finderIf the URL has been submitted multiple times to reddit, it will display the most relevant post based on your setting. newest, mostUpvoted, mostComments
data-themeChange the theme light, dark
data-show-submitIf we don't find a post on reddit, should we display a "submit to reddit" widget. true,false
example with options
<script src='//redditjs.com/post.js' data-url='http://www.techodrom.com/etc/star-trek-edges-closer-reality-tractor-beam-moves-object-using-nothing-power-ultrasound/' data-height='500' data-width='500' data-post-finder='newest' data-theme='dark' data-show-submit='true'  </script>

Subreddit embed widget

Instructions

Add this script tag where you want the subreddit widget to appear.

<script src='//redditjs.com/subreddit.js'></script>

Options

All of these options are optional.
NameDescription values
data-subredditThe subreddit you want to embed any subreddit
data-domainIf you want to embed all posts coming from a domain. Do not include if you want to embed a regular subreddit any valid domain
data-widthWidth of the post widget. number
data-heightHeight of the post widget. number
data-sortSort order of subreddit hot, new, controversial, rising, top, gilded
data-themeChange the theme light, dark
data-timeframeIf top or controversial is select you can show posts from a specific time period. hour,day,week,month,year,all
data-subreddit-modeHow you want to display a subreddit normal,small,grid,large
example with options
<script src='//redditjs.com/subreddit.js' data-subreddit='BeavisAndButthead' data-height='500' data-width='500' data-sort='top' data-theme='light' data-timeframe='month' data-subreddit-mode='grid'></script>

How to run redditjs locally

  • Clone repo git clone [email protected]:BenjaminAdams/RedditJS.git
  • In the console type npm install
  • sudo npm -g install nodemon This starts the node server and monitors for changes in the files and updates the code running on node
  • Run the project and watch for live changes to the code type nodemon and you should be able to open it in http://localhost:8002/
  • To minify the code for production type grunt which creates styles.min.css and main.min.js
  • Changing NODE_ENV to production will use the minified resources

How to setup oauth to run locally or on your own server

Via command line, and also put at bottom of ~/.profile to keep set on system restart

    export REDDIT_KEY = 'your key'
    export REDDIT_SECRET = 'your secret'
    export REDDIT_CALLBACK = 'http://localhost:8002/auth/reddit/callback'
    export SESSION_SECERET = 'make up some random string'

Thanks

Hire me to build your next webapp