Giter VIP home page Giter VIP logo

live-scores's Introduction

Live Cricket Scores

Introduction

This is the monorepo for the Live Cricket Scores Service. This service is built using an AWS event driven architecture to find HTML scorecards and publish updates to S3, web sockets, webpush whenever the scores are updated.

Source code is found under the packages/ directory:

  • functions for lambda functions entry points
  • libs for common libraries that are used by apps
  • scorecard-processor for the scorecard processor process

Installation

This repo makes use of Turbo Repo and NPM workspaces to aid with monorepo setup.

Install: npm i

Dependencies between commands can also be found in turbo.json

Architecture Diagram

Architecture

Deployment

The service is deployed using Terraform. The definitions can be found in the terraform directory and the service is deployed by the deploy.yml GHA workflow every time main is updated.

The deployment workflow requires the following secrets in the Github repository:

  • AWS_ACCESS_KEY_ID - AWS access key
  • AWS_SECRET_ACCESS_KEY - AWS secret key
  • SANITY_EDIT_TOKEN - edit token for updating the result in Sanity. Disable updating Sanity by throttling the update-sanity lambda
  • API_KEY - API key for the API endpoints to subscribe to score and socket updates
  • VAPID_SUBJECT - Webpush Vapid subject. Disable webpush by throttling the web-notify lambda
  • VAPID_PUBLIC_KEY - Webpush Vapid public key. Disable webpush by throttling the web-notify lambda
  • VAPID_PRIVATE_KEY - Webpush Vapid private key. Disable webpush by throttling the web-notify lambda

Vapid keys can be created here

live-scores's People

Contributors

chrisdobby avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.