Git Product home page Git Product logo

kreeftje's Introduction

Kreeftje ๐Ÿฆž

This is a little terminal reader for lobste.rs. I love reading the site, so I made a little terminal user interface for it. This is not finished, but that does not matter.

Screenshot, 2022-07-10

Installation

git clone https://github.com/koenwestendorp/kreeftje
cd kreeftje
cargo install --path .

Usage

(Given that your ~/.cargo/bin/ is in your $PATH.)

kreeftje

Otherwise, running from the source directory would suffice too, of course.

cargo run --release

Key bindings

Within the program, the following key bindings can be used for navigation.

โ†, โ†’, h, l : Move between the stories list and comments view.

โ†“, โ†‘, j, k : Select next and previous stories in the stories list page. Move up and down in the comments view.

J, K : Move to the next and previous page when in the stories list. Move to the next and previous story when in the comments view.

g, G : Move to the top and bottom of the stories list or comments view.

o, Enter : Open the selected story in the browser.

(That browser will be the default browser for your system, and respects your $BROWSER environment variable. For further information, see the documentation of the webbrowser crate that is used under the hood.)

q, <ctrl-C> : Quit the program.

The name

The name 'kreeftje' is dutch for little lobster. Because my program is like a tiny version of the actual site, I think the name is cute and appropriate <3.

Things I might implement

  • Ability to read comments associated with the stories. Comments can be accessed through a rightward motion (โ†’ or l), and navigated in a separate view.
  • Tag coloring, just like on the site.
  • Command line arguments to specify preferences.
  • Config file abilities.
  • Clear help and info.
  • A way of 'selecting' stories, say by hitting the space bar, and then applying operations on them. Such operations could include saving stories, or opening them by bulk in the browser.
  • API, rather than scraping the site??

kreeftje's People

Contributors

ma3ke avatar

Stargazers

 avatar

Watchers

 avatar  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.