Coder Social home page Coder Social logo

axellh / snoo Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 14.64 MB

A Reddit command line client written in Node.js, using modern ES-features

Home Page: https://www.npmjs.com/package/snoo

License: MIT License

JavaScript 98.33% Shell 1.07% Batchfile 0.60%

snoo's Introduction

Snoo

A Reddit command line client written in Node.js, using modern ES-features

Snoo

Features

Snoo allows you to:

  • browse hot, new & top subreddits
  • browse your subscribed subreddits
  • preview articles
  • read articles
  • read the top comments of articles
  • save and unsave articles (no categories yet, though)
  • be warned if an article is NSFW before opening it

... and there's a lot more to come!

Installation

GitHub

$ git clone [email protected]:twostairs/snoo.git
$ cd snoo
$ npm install
$ cat .env.example | while read line; do echo export $line; done > ~/.config/snoo
$ vim ~/.config/snoo # & adjust settings
$ vim ~/.bashrc # or .bash_profile, .zshrc, ... -> add `source ~/.config/snoo`
$ npm link

In order to get REDDIT_APP_KEY and REDDIT_APP_SECRET you need to create your own reddit app as a script. name, description, about url and redirect url don't matter.

For REDDIT_USERNAME and REDDIT_PASSWORD you need to enter the credentials of the user you created the app with. Snoo does not use your credentials for anything else but logging in. If you want to be sure, check out the source code.

Info: Don't use ~ in the SNOO_LOG_FILE path, as it's not (yet) supported.

NPM

$ npm install -g snoo
$ cat /your/global/node_modules/snoo/.env.example | while read line; do echo export $line; done > ~/.config/snoo
$ vim ~/.config/snoo # & adjust settings
$ vim ~/.bashrc # or .bash_profile, .zshrc, ... -> add `source ~/.config/snoo`

Running

$ snoo

Usage

  • ctrl+q: Quit Snoo
  • ctrl+r: Refresh articles
  • arrow up/arrow down: Scroll through articles list
  • space: Preview selected article
  • return: Open article, automatically in external browser or article viewer, depending on the type of the article
  • ctrl+v: Open article in viewer
  • ctrl+s: Save/unsave selected article
  • ctrl+t: Open own subreddits list for switching
  • escape: Go back to the articles list

Feedback & suggestions

Shoot me a tweet. :-)

snoo's People

Contributors

mrusme avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.