Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 4.52 KB

readme.md

File metadata and controls

111 lines (76 loc) · 4.52 KB
Raw


Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp
www.coldbox.org | www.ortussolutions.com

WELCOME TO THE CBFEEDS MODULE

A nice and functional way to consume and produce RSS, ATOM feeds the ColdBox way!

DOCUMENTATION

https://github.com/coldbox-modules/cbfeeds/wiki

LICENSE

Apache License, Version 2.0.

IMPORTANT LINKS

SYSTEM REQUIREMENTS

  • Lucee 5+
  • ColdFusion 2018+

INSTRUCTIONS

Just drop into your modules folder or use CommandBox to install

box install cbfeeds

The module registers the following mappings in WireBox:

  • FeedReader@cbfeeds - Reads feeds with caching enhancements
  • feedGenerator@cbfeeds - Generate all kinds of feeds

Then you can use each of the model objects to read or generate feeds to your heart's content.

Settings

The module can be configured via settings in your ColdBox.cfc in a structure called feeds:

feeds = {
    // leverage the cache for storage of feed reading, leverages the 'default' cache
    useCache  = true,
    // The cache provider to use for storing the cached elements
    cacheProvider = "default",
    // where to store the cache, options are: [ram, file]
    cacheType = "ram",
    // if using file cache, the location to store the cached files
    cacheLocation = "",
    // the cache timeout for the items in seconds
    cacheTimeout = 30,
    // the http timeout for the cfhttp operations in seconds
    httpTimeout = 30
};

Samples + Documentation

If you want examples just look at the shell sample app in the repository: https://github.com/coldbox-modules/cbfeeds

Or the online documentation for the module: https://github.com/coldbox-modules/cbfeeds/wiki

Welcome to ColdBox

ColdBox Hierarchical MVC is the de-facto enterprise-level HMVC framework for ColdFusion (CFML) developers. It's professionally backed, conventions-based, modular, highly extensible, and productive. Getting started with ColdBox is quick and painless. ColdBox takes the pain out of development by giving you a standardized methodology for modern ColdFusion (CFML) development with features such as:

Learning ColdBox

ColdBox is the defacto standard for building modern ColdFusion (CFML) applications. It has the most extensive documentation of all modern web application frameworks.

If you don't like reading so much, then you can try our video learning platform: CFCasts (www.cfcasts.com)

Ortus Sponsors

ColdBox is a professional open-source project and it is completely funded by the community and Ortus Solutions, Corp. Ortus Patreons get many benefits like a cfcasts account, a FORGEBOX Pro account and so much more. If you are interested in becoming a sponsor, please visit our patronage page: https://patreon.com/ortussolutions

THE DAILY BREAD

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12