Skip to content

SigmaEnterprise/anonymous-news-aggregator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Anonymous News Aggregator

A simple news aggregator application that fetches and stores RSS feed articles from multiple sources. The application is built using Node.js, Express, SQLite3, and RSS-parser.

Features

  • Fetches and aggregates news articles from various RSS feeds.
  • Stores the articles in a SQLite database.
  • Provides an API to retrieve stored articles.
  • Serves a web frontend to display the articles.

Tech Stack

  • Backend: Node.js, Express, SQLite3
  • Frontend: HTML, CSS, JavaScript
  • RSS Parsing: RSS-Parser

Installation

Prerequisites

  1. Node.js: Download and install Node.js
  2. Git: Download and install Git

Steps

  1. Clone this repository:

    git clone https://github.com/your-username/anonymous-news-aggregator.git
    cd anonymous-news-aggregator
  2. Install the dependencies:

    npm install
  3. Ensure you have the feeds.json file and news.db file:

    • feeds.json: A JSON file containing RSS feed URLs and their respective names.
    • news.db: The SQLite database where the articles will be stored (automatically created on the first run if it doesn't exist).
  4. Start the server:

    node server.js

    The server will start on http://localhost:3000.

Usage

  1. Visit the homepage:
    Open a web browser and go to http://localhost:3000.

  2. API:
    To get all the articles, make a GET request to the following endpoint:

    http://localhost:3000/api/articles

    This will return a JSON response with the latest 50 articles.

Project Structure

  • backend/: Contains server-side logic and database files.
    • server.js: The main server file with routes and logic for fetching and storing RSS feeds.
    • news.db: SQLite3 database storing articles.
    • feeds.json: A JSON file containing RSS feed URLs and source names.
  • frontend/: Contains the frontend files (HTML, CSS, JS) served by Express.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature).
  6. Create a new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to RSS-Parser for simplifying RSS feed parsing.
  • Thanks to SQLite3 for the lightweight database solution.

### Customization Notes:
- Replace `https://github.com/your-username/anonymous-news-aggregator.git` with the actual GitHub URL of your project.
- You may want to adjust the sections to fit your specific needs, e.g., adding further instructions, setup, or troubleshooting steps. 

### How to Use:
1. Create a new file in your project folder called `README.md`.
2. Copy the contents of this template into that file.
3. Push the `README.md` to your GitHub repository. 

About

intended to be a rss news aggregator for tor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published