Skip to content

Latest commit

聽

History

History
59 lines (41 loc) 路 1.62 KB

README.md

File metadata and controls

59 lines (41 loc) 路 1.62 KB
Raw

KCHUNG Radio Schedule API

Get every KCHUNG Radio broadcast event for the current month. Or specify a year and a month.

The API pulls data from the KCHUNG Radio Broadcast Schedule Google Calendar.

Usage

Requesting Data

When requesting data from the API, you'll receive json in the following format:

{
  "id":"9inr77jglg5qpuu68qc8k25voc_20170401T190000Z",
  "name":"primary ingredients",
  "start":"2017-04-01T12:00:00-07:00",
  "end":"2017-04-01T13:00:00-07:00",
  "url":"http://lacarchive.com/kchung/archive/show/primary%20ingredients"
}

Filtering Data

Any event whose name includes the words 'TENTATIVE', 'TBD', 'Open Slot', or 'DONOTLIST' will not be returned.

Replacing the URL

By default, the url field will be generated automatically by the api, like in the example above. name is processed by encodeURI() to escape certain characters.

If there is a url anywhere in the description field for that event in the google calendar then that url will be used instead. If there are multiple urls, the first will be used.

Run locally

git clone this repository.

Get env_secrets.sh from a secure channel and place in lib/auth/.

Install dependencies and run:

yarn
yarn dev

Or alternatively:

npm install
npm run dev

Contributing

Make your changes, create a Pull Request, wait for it to be merged.

Deploy to the cloud with now:

now kchungradio/schedule-api