https://github.com/nerddiffer/reddux
Read reddit
https://github.com/nerddiffer/reddux
Last synced: 12 months ago
JSON representation
Read reddit
- Host: GitHub
- URL: https://github.com/nerddiffer/reddux
- Owner: NerdDiffer
- Created: 2016-11-23T02:57:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-07T22:15:46.000Z (over 9 years ago)
- Last Synced: 2025-02-12T20:31:12.841Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://reddux.herokuapp.com
- Size: 1.37 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reddux
A content reader for Reddit. Built with React, Redux and Semantic-UI.
See a [live demo](https://reddux.herokuapp.com/).
## OAuth
You'll need to register a developer app. [Read about that here](https://github.com/reddit/reddit/wiki/OAuth2#getting-started).
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](http://semantic-ui.com/) framework for
consistent styling.
* Globally install [gulp](https://github.com/gulpjs/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](https://github.com/Semantic-Org/Semantic-UI/issues/3620)
recommends it.
##### Semantic-UI docs
Read these to know more:
* [Getting Started](http://semantic-ui.com/introduction/getting-started.html)
* [Theming](http://semantic-ui.com/usage/theming.html)
* [React integration](http://react.semantic-ui.com/)
## Starting, building
### Development
* Bundle application & serve it in-memory:
* `npm start`
* Visit [http://localhost:8080](http://localhost:8080).
### 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`