Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 5.09 KB

README.md

File metadata and controls

68 lines (48 loc) · 5.09 KB

  Karuna 2020 Open Data

This repository contains all our data — contributors, donors, beneficiaries, and more, directly from the Airtable and Google Sheets databases we use as our central information repositories.

Open Data status Build status Vulnerabilities David GitHub Last commit

📈 Data

Airtable

The following endpoints come from our Airtable databases.

File Data CDN URL
summary.json Quick summary of important data API Endpoint
volunteers.json List of our volunteers.json API Endpoint
donations.json List of our donors API Endpoint
distribution.json List of food distribution API Endpoint
procurement.json Raw material procurement details API Endpoint
partners.json List of our partners API Endpoint
social-media-outreach.json Social media and blog posts API Endpoint

Google Sheets

The following endpoints come from our Google Sheets spreadsheets.

File Data CDN URL
amount-received.json List of financial contributors and amounts API Endpoint
amount-payable.json List of outgoing transactions API Endpoint
infrastructure.json List of our available infrastructure API Endpoint
sop-s.json Our SOPs (standard operating procedures) API Endpoint
concalls.json Summary of our conference calls API Endpoint
things-to-be-done.json List of things to be done API Endpoint

💡 How it works

  • We maintain our central MIS in a Google Sheets spreadsheet
  • Every hour, a GitHub Actions workflow is triggered
  • Our friends at SheetDB help us convert spreadsheet tabs to JSON files
  • We commit these JSON files to this repository and deploy them to our API

API endpoint: https://open-data.karuna2020.org

For example, the list of money raised is available at https://open-data.karuna2020.org/amount-received.json

👩‍💻 Development

Build TypeScript:

npm run build

Update data (triggered by GitHub Actions):

npm run update-data

📄 License

This data is available under CC BY 4.0.