Giter Club home page Giter Club logo

craft3-rssclient's Introduction

RSSClient plugin for Craft CMS 3.x

Just a simple RSS client

Installation

To install RSSClient, follow these steps:

  1. Download & unzip the file and place the rssclient directory into your craft/plugins directory
  2. -OR- do a git clone https://github.com/venveo/craft3-RSSFeed directly into your craft/plugins folder. You can then update it with git pull
  3. Install plugin in the Craft Control Panel under Settings > Plugins
  4. The plugin folder should be named rssclient for Craft to see it. GitHub recently started appending -master (the branch name) to the name of the folder for zip file downloads.

RSSClient works on Craft 3.x.

Using RSSClient

This plugin exposes a service variable called rssfeed with a function called getFeed that will retrieve data from a valid RSS feed and allow you to use it in a template.

####Example:

{% set feed = craft.rssclient.getFeed('http://feeds.feedburner.com/jumbojoke') %}
{% set jokes = feed %}

{% for joke in jokes %}
    <strong>{{ joke.title }}</strong>
    {{ joke.summary | raw }}
{% endfor %}

Todo

  • Caching mechanism to prevent extraneous http requests from Guzzle
  • Synchronizing with entry type via channel
  • Cleaner/easier pagination
  • More comprehensive error logging

Contributing

Contributions are encouraged, please ensure your commits are descriptive and start with a verb. Create a pull-request of your feature branch onto the master branch. When your PR is approved and merged, a Venveo team member will tag, update the changelog, and create a new release.

Credits

mattstein for his original Craft 2 implementation which this project follows very closely.

craft3-rssclient's People

Contributors

mosnar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.