Giter Club home page Giter Club logo

karoloslykos / hackertea Goto Github PK

View Code? Open in Web Editor NEW
9.0 1.0 1.0 4.73 MB

#Hackertea is a sleek terminal user interface written in Golang, designed to bring HackerNews articles directly to your fingertips. Powered by the magic of Golang and the #bubbletea library. Just fire up your terminal, launch Hackertea, and dive into the latest HackerNews stories with ease. Happy hacking! ๐Ÿš€

Home Page: https://github.com/KarolosLykos/hackertea

Go 100.00%
bubble bubbletea cli elm-architecture go golang hackernews terminal tui lipgloss

hackertea's Introduction

๐Ÿ’ป Hackertea | Hackernews TUI

A minimal application for browsing Hacker News on the terminal

Go version Downloads Build Status Build Status Build Status
Stars Forks Issues


A command-line interface (CLI) tool that allows users to browse the Top, New, and Best stories on Hacker News. The tool includes a minimalist text-based user interface (TUI) that is developed using Bubble Tea, Lip Gloss, and Bubble libraries.

Welcome to Hachertea

Installation

Packages

macOS

  • with Homebrew: brew install karoloslykos/tap/hackertea

Binaries

Go

Or just install it with go:

go install github.com/KarolosLykos/hackertea@latest

Build From Source

Or just build it yourself (requires Go 1.1x+):

git clone https://github.com/KarolosLykos/hackertea.git
cd hackertea
go build .

Features

  • Read Top, New and Best stories.
  • Fetch stories concurrently. (You can set the number of workers in the config file)
  • In-memory thread-safe cache for caching news.
  • A shiny UI to gaze your eyes upon.
    • Tabs
    • Separate pagination for each tab
    • Fetch next pages
    • Vim-like movements

Libraries used

  • Bubbletea: The fun, functional and stateful way to build terminal apps.
  • Bubbles: Common Bubble Tea components such as text inputs, viewports, spinners and so on
  • Lip Gloss: Style, format and layout tools for terminal applications

Styling

The default theme is already loaded by default, but the good news is that you have the option to add any theme of your choice! Simply take a look at the "config-example.yaml" file to see the available options.

Welcome to Hachertea

Roadmap

  • Add more screens
    • Add Comments screen
    • Add User profile screen
    • Add Ask HN screen
    • Add Jobs screen
  • Add Changelog
  • Add additional styling options w/ Examples
  • Multi-language Support

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. To get started, take a look at CONTRIBUTING.md

hackertea's People

Contributors

actions-user avatar dependabot[bot] avatar karoloslykos avatar nicolasghs avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

nicolasghs

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.