Skip to content

NerdDiffer/reddux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reddux

A content reader for Reddit. Built with React, Redux and Semantic-UI. See a live demo.

OAuth

You'll need to register a developer app. Read about that here. Choose 'web app' for your app type.

Using the template at config/env_template, save your credentials in .env.

Scope explanations

As a user, the app will ask for access to your account. Here are the features that use account permissions, by their OAuth scope:

  • read: get the most popular subreddits
  • mysubreddits: fetch a list of your subscriptions
  • subscribe: manage your subscriptions

Installations

Application dependencies

npm install

Style framework info

This app is using the Semantic-UI framework for consistent styling.

  • Globally install gulp
    • npm install -g gulp
  • Build the source:
    • npm run build:styles

There may be an interactive postinstall script, that asks how you want to customize your build of semantic-ui. Just choose the default choices all the through. If there's a problem, make sure to set the source and output directories as per the file semantic.json, at the project root.

Component definitions & preset themes are committed to source control. This GitHub issue recommends it.

Semantic-UI docs

Read these to know more:

Starting, building

Development

Production

To locally test a production build:

  • Remove all build files
    • npm run clean
  • Install production dependencies
    • npm install --production
  • Build style framework, bundle application & output to public/build
    • npm run heroku-postbuild
  • Start app:
    • NODE_ENV=production npm start

Tests

Run tests in selected application parts, or all of them:

  • src/ only
    • npm test
  • custom test utilities
    • npm test:helpers
  • everything
    • npm test:all

Releases

No releases published

Packages

No packages published