https://github.com/creativcoder/headlines
[WIP] A simple news reading GUI app built in Rust
https://github.com/creativcoder/headlines
app application egui gui rustlang tutorial
Last synced: 3 months ago
JSON representation
[WIP] A simple news reading GUI app built in Rust
- Host: GitHub
- URL: https://github.com/creativcoder/headlines
- Owner: creativcoder
- Created: 2021-10-10T18:04:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T20:21:39.000Z (almost 2 years ago)
- Last Synced: 2025-03-23T23:15:09.164Z (4 months ago)
- Topics: app, application, egui, gui, rustlang, tutorial
- Language: Rust
- Homepage:
- Size: 5.03 MB
- Stars: 113
- Watchers: 4
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: newsapi/Cargo.lock
Awesome Lists containing this project
- awesome-egui - headlines
README
Headlines [WIP]
A cross platform native GUI app built with Rust using [egui](https://github.com/emilk/egui). Uses newsapi.org as the source to fetch news articles.
This project is intended to serve as educational content
for folks learning Rust. To follow along in the journey check out the video walkthoughs below:
## Video walkthroughs
[EP 7a](https://youtu.be/NtUkr_z7l84)
[EP 7b](https://www.youtube.com/watch?v=SvFPdgGwzTQ)
[EP 8](https://www.youtube.com/watch?v=4MKcqR9z8AU)
[EP 9](https://youtu.be/EOIhsRxhV80)
Subscribe to the [creativcoder](https://www.youtube.com/c/creativcoder?sub_confirmation=1) channel to stay updated for more.
## Implementation Status / Roadmap
- [X] Base UI
- [X] Integrate dark mode
- [X] Integrate real articles feed.
- [X] Config window for setting API_KEY
- [X] State persistance
- [X] Cross platform
- [ ] Build and release script
- [ ] CI integration using GitHub Actions
- [ ] More API features
- [ ] Multiple news sources.
## Build and run instructions
Before building headlines make sure you have rust toolchain installed and `egui` [dependencies](https://github.com/emilk/egui#demo) are installed.
### Linux
`cargo run`
### Windows
`cargo run`.
### Mac
`cargo run` should work but would help if someone can test it.
### Web
Headlines can be served from your browser (only at localhost at the moment, because of CORS)
* Run `./setup_web.sh` script to install dependencies.
* Run `./start_web.sh` to spawn the app in the browser.
## Contributions
All kinds of contributions are welcome.
## License
MIT