The StreamKit project is intended to showcase DonorDrive API best practices in a collection of utilities designed to help charity stream fundraising campaigns. The StreamKit leverages Vue, Axios, Moment.js, Numeral.js, Animate.css and Bootstrap.
config.js
serves as a single reference point to inform StreamKit widgets where to look for information, as well as their look and feel. The 3 properties that must be set are:
api
- the url of the DonorDrive API you wish to pollresource
- the resource (events, participants, teams)resourceID
- the ID of the specific resource to poll
donation-ticker
takes advantage of the etag
returned from an initial call to a resource before making a subsequent call to retrieve new/recent donations.
streaming-alerts
offers a quick shout-out to donors, giving the opportunity for more central placement within a stream.
streaming-thermometer
is a persistent element that tracks fundraising progress against your goal in DonorDrive. Donation alerts are enabled by default, but may be disabled if this is used in conjunction with streaming-alerts
(set streamingThermometer.showDonations
to false
).