bench get-app https://github.com/appliedrelevance/epifeed

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=appliedrelevance%2Fepifeed)](https://frappegems.com/gems/apps/appliedrelevance/epifeed)

EpiFeed

EpiFeed is a Frappe application designed to generate RSS and Atom feeds for your Frappe/ERPNext blog posts. It provides a configurable way to syndicate your blog content, allowing external applications and RSS readers to easily subscribe to your updates.

Features

• Configurable Feed Settings: Manage feed title, description, base URL, update frequency, and feed standard (RSS 2.0 or Atom 1.0) via a dedicated "RSS Settings" DocType.
• Content Inclusion Options: Choose to include full blog post content or a summary, and optionally include featured images in your feed.
• Real-time & Scheduled Updates: Supports real-time feed regeneration on blog post updates/creations/deletions, and scheduled updates (hourly/daily) for efficient content delivery.
• Publicly Accessible: Generates a public web route for easy access to your RSS/Atom feed without authentication.

Installation

1. Clone the repository:

   cd /path/to/your/frappe-bench/apps
   git clone https://github.com/appliedrelevance/epifeed.git
   

2. Install the app:

   cd /path/to/your/frappe-bench
   bench get-app epifeed https://github.com/appliedrelevance/epifeed.git
   bench install-app epifeed
   bench migrate
   

Usage

1. Configure RSS Settings:

   • Log in to your Frappe/ERPNext instance.
   • Go to the Awesomebar (search bar) and type "RSS Settings".
   • Open the "RSS Settings" document.
   • Fill in the required fields:
     • Feed Title: Title of your RSS feed (e.g., "My Company Blog").
     • Feed Description: A brief description of your feed.
     • Feed Link (Base URL): The base URL of your Frappe site (e.g., https://your-frappe-site.com). This is crucial for correct link generation within the feed.
     • Update Frequency: Select how often the feed should be regenerated (e.g., "Daily", "Hourly", "Real-time", "On-Demand").
     • Feed Standard: Choose between "RSS 2.0" or "Atom 1.0".
     • Maximum Items in Feed: Specify the maximum number of recent blog posts to include.
     • Include Full Content: Check this option to include the full HTML content of blog posts in the feed.
     • Include Featured Image: Check this option to include the featured image URL as an enclosure in the feed.
   • Save the "RSS Settings" document.

2. Access the RSS Feed:

   • Once configured, your RSS feed will be available at: [Your Frappe Site URL]/epifeed/rss
   • You can subscribe to this URL using any RSS reader or integrate it with other applications.

Development

To contribute to EpiFeed, please follow the standard Frappe development guidelines.

License

This project is licensed under the MIT License.