Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msminhas93/hacker_pulse
https://github.com/msminhas93/hacker_pulse
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/msminhas93/hacker_pulse
- Owner: msminhas93
- Created: 2024-08-15T17:40:23.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-29T19:35:44.000Z (4 months ago)
- Last Synced: 2024-11-01T06:42:05.476Z (2 months ago)
- Language: Rust
- Size: 143 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hacker Pulse
Hacker Pulse is a terminal-based user interface (TUI) application that allows you to browse the latest submissions from Hacker News. With a simple and intuitive interface, you can navigate through articles, open links in your browser, and refresh the list of submissions.
## Table of Contents
- [Hacker Pulse](#hacker-pulse)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- Browse the latest Hacker News submissions.
- Navigate through articles using the arrow keys.
- Open articles in your default web browser.
- Refresh the list of submissions.
- Pagination support to navigate through multiple pages of articles.
## Installation
To install Hacker Pulse, you need to have Rust and Cargo installed on your machine. If you haven't installed Rust yet, you can do so by following the instructions on the [official Rust website](https://www.rust-lang.org/tools/install).
Once you have Rust and Cargo installed, you can clone the repository and build the project:
```bash
git clone https://github.com/yourusername/hacker_pulse.git
cd hacker_pulse
cargo build --release
```
## Usage
To run Hacker Pulse, execute the following command in your terminal:
```bash
cargo run
```
This will start the application, and you will see the latest submissions from Hacker News.
Key Bindings
- ↑ / ↓: Navigate through the list of articles.
- →: Open the selected article in your default web browser.
- r: Refresh the list of submissions.
- n: Go to the next page of submissions.
- p: Go to the previous page of submissions.
- esc / q: Quit the application.
## Contributing
Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.
Fork the repository.
## License
This project is licensed under the MIT License.