Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simonschaufi/gkh_rss_import

TYPO3 extension to import an RSS feed and show the content on a page
https://github.com/simonschaufi/gkh_rss_import

rss rss-feed typo3 typo3-cms-extension

Last synced: 2 months ago
JSON representation

TYPO3 extension to import an RSS feed and show the content on a page

Awesome Lists containing this project

README

        

# TYPO3 extension `gkh_rss_import`

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/simonschaufi/10)
[![Latest Stable Version](https://poser.pugx.org/gkh/gkh-rss-import/v/stable)](https://packagist.org/packages/gkh/gkh-rss-import)
[![Total Downloads](https://poser.pugx.org/gkh/gkh-rss-import/downloads)](https://packagist.org/packages/gkh/gkh-rss-import)
[![License](https://poser.pugx.org/gkh/gkh-rss-import/license)](https://packagist.org/packages/gkh/gkh-rss-import)
[![TYPO3](https://img.shields.io/badge/TYPO3-12-orange.svg)](https://get.typo3.org/version/12)

Fetch an RSS / Atom Feed and display its content on the Frontend.

## Features

* Frontend plugin, implementing best practices from TYPO3 CMS
* Supports editors & authors by providing
* Lots of plugin options for flexible output rendering
* Local caching of external feed content
* Marker based template
* [Comprehensive documentation][1]

## Usage

### Installation

#### Installation using Composer

The recommended way to install the extension is using [Composer][2].

Run the following command within your Composer based TYPO3 project:

```bash
composer require gkh/gkh-rss-import
```

#### Installation as extension from TYPO3 Extension Repository (TER)

Download and install the [extension][3] with the extension manager module in the TYPO3 backend.

## Integration

- Add the TypoScript configuration in the Template module
- Add the Plugin on a page and configure it in the plugin settings right in the content element

## Administration corner

### Versions and support

| Branch | TYPO3 | PHP | Support / Development |
|----------|-------------|-----------|-----------------------------|
| dev-main | 12.0 - 12.0 | 8.1 - 8.3 | unstable development branch |
| 9.x | 11.5 - 11.5 | 7.4 - 8.1 | bugfixes, security updates |
| 8.x | 9.5 - 11.5 | 7.2 - 7.4 | no more support |
| 6.x | 8.7 - 8.7 | 7.0 - 7.4 | no more support |

### Changelog

Please look into the [official extension documentation in changelog chapter][4].

### Release Management

We follow [**semantic versioning**][5], which means, that
* **bugfix updates** (e.g. 1.0.0 => 1.0.1) just includes small bugfixes or security relevant stuff without breaking changes,
* **minor updates** (e.g. 1.0.0 => 1.1.0) includes new features and smaller tasks without breaking changes,
* and **major updates** (e.g. 1.0.0 => 2.0.0) breaking changes wich can be refactorings, features or bugfixes.

### Contribution

**Pull Requests** are gladly welcome! Please don't forget to add an issue and connect it to your pull requests. This
is very helpful to understand what kind of issue the **PR** is going to solve.

Bugfixes: Please describe what kind of bug your fix solve and give us feedback how to reproduce the issue. We're going
to accept only bugfixes if we can reproduce the issue.

### Similar extensions

* [rss_display][6] Based on extbase but with less configuration options

[1]: https://docs.typo3.org/p/gkh/gkh-rss-import/master/en-us/
[2]: https://getcomposer.org/
[3]: https://extensions.typo3.org/extension/gkh_rss_import
[4]: https://docs.typo3.org/p/simonschauif/gkh_rss_import/master/en-us/Changelog/Index.html
[5]: https://semver.org/
[6]: https://extensions.typo3.org/extension/rss_display/