Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.75 KB

README.md

File metadata and controls

16 lines (12 loc) · 1.75 KB
Raw

DEPRECATION NOTICE

Warning, this repository will soon be deprecated in favor of openmined-website.

Serverless Website API

Our website needs to gather some information from Github, Slack, and Ghost to display on screen. Unfortunately, due to rate limiting and view count limitations it doesn't make sense to always ask these services for this information. It's far quicker for us to cache this information elsewhere and retrieve it from there instead.

This code features six functions: updateGithub, deliverGithub, updateSlack, deliverSlack, updateGhost, and deliverGhost. The update functions are run by a cron job on AWS Lambda to get the latest Github repository and membership data, get the latest Slack membership data for the OpenMined community, and get the latest posts made to each of OpenMined's two blogs. It then proceeds to cache this information in a DynamoDB table. The deliver functions are purely a route we can hit to receive this information, pulling from DynamoDB instead of from Github, Slack, and Ghost directly.

Installation

  1. Copy env.sample.yml to env.yml and supply proper Github, Mapbox, Slack, and Ghost keys
  2. Install all dependencies: yarn install
  3. Install DynamoDB locally: sls dynamodb install
  4. Set up your AWS profile or credentials to be used. This is custom to how you want to set up AWS on your computer. It's suggested you set up a profile for OpenMined specifically and run export AWS_PROFILE="openmined". More information can be found here.
  5. Run locally: yarn start
  6. Populate locally: yarn populate (sometimes Github needs to be run multiple times)