https://github.com/rocketchat/apps.news-aggregation
Aggregates news from top websites and displays news in a configurable, user-friendly format with categorization. Provides centralized access to curated news within Rocket.Chat.
https://github.com/rocketchat/apps.news-aggregation
Last synced: 3 months ago
JSON representation
Aggregates news from top websites and displays news in a configurable, user-friendly format with categorization. Provides centralized access to curated news within Rocket.Chat.
- Host: GitHub
- URL: https://github.com/rocketchat/apps.news-aggregation
- Owner: RocketChat
- License: mit
- Created: 2024-05-26T09:27:19.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-08-04T13:24:41.000Z (over 1 year ago)
- Last Synced: 2025-09-29T01:40:00.372Z (3 months ago)
- Language: TypeScript
- Size: 3.85 MB
- Stars: 9
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: news-aggregation/.editorconfig
- License: LICENSE
Awesome Lists containing this project
README
News Aggregation App for RocketChat
Aggregates news from top websites and displays news in a configurable, user-friendly format with categorization. Provides centralized access to curated news within Rocket.Chat.
View Demo
·
Report Bug
·
Request Feature
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
## 📜 Getting Started
### Prerequisites
- You need a Rocket.Chat Server Setup
- Rocket.Chat.Apps CLI,
* In case you don't have run:
```sh
npm install -g @rocket.chat/apps-cli
```
### ⚙️ Installation
- Every RocketChat App runs on RocketChat Server, thus every time you want to test, you need to deploy the app with this note. Let's start setting up:
1. Clone the repo
```sh
git clone https://github.com//Apps.News-Aggregation
```
2. Install NPM packages
```sh
npm install
```
3. Deploy the app using:
```sh
rc-apps deploy --url --username --password
```
4. Generate LLM API Key:
Generate an API key from [Mistral API Console](https://console.mistral.ai/api-keys/) and add it in the settings of the app. Navigate to:
```
Installed -> Private Apps -> News-Aggregation App -> Settings -> Enter API Key.
```
## ✅ About The Project:
The News Aggregation App aims to provide a centralized platform for seamless access to curated news content within Rocket.Chat. It aggregates news from top websites, displaying them in a user-friendly format with complete configurability of sources and categories.
## 👷♀️ Architecture:
## 🚀 Usage:
Use the following slash commands to interact with the app:
```
/news alert: Get the latest news summaries on demand.
/news help: Learn about the app, its features, and how to configure it.
/news channels: List all channels where the app is configured.
/news subscribe: Configure your news preferences through a modal.
/news unsubscribe: Unsubscribe from receiving periodic news updates.
```
## 🧑💻 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**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue.
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
3. Commit your Changes (`git commit -m 'feat: adds some amazing feature'`)
4. Push to the Branch (`git push origin feat/AmazingFeature`)
5. Open a Pull Request
## 📚 Resources
Here are some links to examples and documentation:
- [Rocket.Chat Apps TypeScript Definitions Documentation](https://rocketchat.github.io/Rocket.Chat.Apps-engine/)
- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-engine)
- [Example Rocket.Chat Apps](https://github.com/graywolf336/RocketChatApps)
- [DemoApp](https://github.com/RocketChat/Rocket.Chat.Demo.App)
- [GithubApp](https://github.com/RocketChat/Apps.Github22)
- Community Forums
- [App Requests](https://forums.rocket.chat/c/rocket-chat-apps/requests)
- [App Guides](https://forums.rocket.chat/c/rocket-chat-apps/guides)
- [Top View of Both Categories](https://forums.rocket.chat/c/rocket-chat-apps)
- [#rocketchat-apps on Open.Rocket.Chat](https://open.rocket.chat/channel/rocketchat-apps)
[contributors-shield]: https://img.shields.io/github/contributors/RocketChat/Apps.News-Aggregation?style=for-the-badge
[contributors-url]: https://github.com/RocketChat/Apps.News-Aggregation/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/RocketChat/Apps.News-Aggregation?style=for-the-badge
[forks-url]: https://github.com/RocketChat/Apps.News-Aggregation/network/members
[stars-shield]: https://img.shields.io/github/stars/RocketChat/Apps.News-Aggregation?style=for-the-badge
[stars-url]: https://github.com/RocketChat/Apps.News-Aggregation/stargazers
[issues-shield]: https://img.shields.io/github/issues/RocketChat/Apps.News-Aggregation?style=for-the-badge
[issues-url]: https://github.com/RocketChat/Apps.News-Aggregation/issues
[license-shield]: https://img.shields.io/github/license/RocketChat/Apps.News-Aggregation?style=for-the-badge
[license-url]: https://github.com/RocketChat/Apps.News-Aggregation/blob/master/LICENSE.txt