Giter Club home page Giter Club logo

aping-plugin-rss's Introduction

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-rss is a RSS plugin for apiNG.

Information

  • Supported apiNG models: social, native (RSS)
  • This plugin supports the get-native-data parameter
  • Used RSS->JSON parse service: https://rss2json.com/

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. USAGE
    1. Models
    2. Requests

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

II. Include file

Include aping-plugin-rss.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-rss/dist/aping-plugin-rss.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-rss/dist/aping-plugin-rss.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/npm/aping-plugin-rss@latest/dist/aping-plugin-rss.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-rss.min.js"></script>

III. Add dependency

Add the module jtt_aping_rss as a dependency to your app module:

angular.module('app', ['jtt_aping', 'jtt_aping_rss']);

IV. Add the plugin

Add the plugin's directive aping-rss="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/social.html"
    model="social"
    items="20"
    aping-rss="[{'path':'http://blog.hackerearth.com/feed'}]">
</aping>

2. USAGE

I. Models

Supported apiNG models

model content
social RSS feed
native (RSS) RSS feed

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Requests by URL

parameter sample default description optional
path http://blog.hackerearth.com/feed RSS feed url no
items 15 Items per request (0-n) yes
parseImage false true Use true for try to parse image from content. This parameter only works for social model yes
protocol https Use https or http to force the protocol. Leave it blank to for dynamic choice yes

Sample requests:

  • [{'path':'http://blog.hackerearth.com/feed'}, {'path':'http://www.magazin.dtv.de/index.php/feed/'}]
  • [{'page':'http://rss.nytimes.com/services/xml/rss/nyt/Science.xml', 'items':25}]

Licence

MIT

aping-plugin-rss's People

Contributors

johnnythetank avatar lukasdrgon avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

lukasdrgon

aping-plugin-rss's Issues

chore

  • use .then() instead of .success()
  • create non-minifed dist file
  • create npm reference
    • add this to readme

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.