https://github.com/rcnow/news-aggregator
A simple news aggregator.
https://github.com/rcnow/news-aggregator
news-aggregator rss rss-aggregator rss-reader
Last synced: about 1 month ago
JSON representation
A simple news aggregator.
- Host: GitHub
- URL: https://github.com/rcnow/news-aggregator
- Owner: rcnow
- License: mit
- Created: 2025-03-13T07:38:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-06-23T10:07:43.000Z (4 months ago)
- Last Synced: 2025-06-23T11:25:10.919Z (4 months ago)
- Topics: news-aggregator, rss, rss-aggregator, rss-reader
- Language: Go
- Homepage:
- Size: 245 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# News Aggregator
A simple news aggregator built with Go that fetches news from various RSS and ATOM feeds, processes them, and displays the latest news in a user-friendly web interface. The application supports light and dark themes and is optimized for desktop and mobile devices.
## Features
### Implemented
- Responsive UI with full support for desktops.
- Light and dark themes.
- Support for RSS and ATOM feeds.
### Planned
- Responsive UI for tablets, and mobile devices
- Main screen with customizable widgets.
- Full-fledged desktop applications for Windows and Linux.
- Support for additional feed formats.
## Screenshots
### Light Theme
### Dark Theme
## Prerequisites
Before you begin, ensure you have the following installed:
- [Go](https://golang.org/dl/) (version 1.21 or later)
- A web browser
## Getting Started
Follow these steps to set up and run the project locally.
### 1. Clone the Repository
Clone the repository to your local machine using the following command:
```bash
git clone https://github.com/rcnow/news-aggregator.git
```
### 2. Navigate to the Project Directory
Change into the project directory:
```bash
cd news-aggregator
```
### 3. Add Your Feed Links
Create a `config.na` file or rename `config-example.na` to `config.na`.
Open the `config.na` file and add your RSS feed URLs to the `feed` slice. For example:
```yaml
feed:
url: https://example.com/rss
category: demo
feed:
url: https://example.com/feed
category: world news
```
### 4. Run the Application
Start the server using:
```bash
go run main.go
```
You should see output indicating that the web server is starting.
### 5. Access the Application
Open your web browser and navigate to:
http://localhost:8080
## Resources
- [Go Documentation](https://golang.org/doc/)
- [Project Repository](https://github.com/rcnow/news-aggregator)
- [Customizing Themes](./doc/THEMES.md)
## Credits
- Icons were designed using [Figma](https://www.figma.com/).