Skip to content

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.

License

Notifications You must be signed in to change notification settings

RocketChat/Apps.News-Aggregation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

345 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Apps News-Aggregation2


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 Forks Stargazers Issues MIT License

📜 Getting Started

Prerequisites

  • You need a Rocket.Chat Server Setup
  • Rocket.Chat.Apps CLI,
  • In case you don't have run:
    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

    git clone https://github.com/<yourusername>/Apps.News-Aggregation
  2. Install NPM packages

    npm install
  3. Deploy the app using:

    rc-apps deploy --url <url> --username <username> --password <password>
  4. Generate LLM API Key: Generate an API key from Mistral API Console 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:

arch

🚀 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:

About

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.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •