Giter Club home page Giter Club logo

leaderboard-org-data-template's Introduction

Template repository for Leaderboard Data Repo

Visit Open Healthcare Network's Leaderboard Deployment deployed from coronasafe/leaderboard-data repository.

⚙️ Configuring Scraper

The scraper scripts fetches data every 24 hours. The scraper workflow needs to run at an interval of 24 hours.

To change what time the scraper workflow runs, update the schedule cron value of the action:

# .github/workflows/scraper.yml
on:
  schedule:
    - cron: 0 0 * * *

🔑 Actions Secrets and Variables

Secrets:

Name Description
SLACK_API_TOKEN Optional; Required for scraping EOD messages for slack
GIT_ACCESS_TOKEN Personal Access Token; Needs write permissions to the data repo.

Variables:

Name Description
LEADERBOARD_REPO Optional; Specify to use a fork of the leaderboard app repo.
SLACK_EOD_CHANNEL Optional; The channel ID to use for scanning for EOD messages.

🚀 Deploying Leaderboard

Note

To populate the flat data repository with historical data, run the pullHistoricalGitHubActivities.js script on the flat data repository.

GITHUB_ORG=<ORG_NAME> GITHUB_TOKEN=<GITHUB_PAT> node scripts/pullHistoricalGitHubActivities.js

Environment Variables

GITHUB_PAT Some pages like releases, projects, etc. are server side rendered on-demand or pre-rendered during build time by calling GitHub's APIs and these calls requires authentication. Create a Personal Access Token (docs) with the following scopes repo, read:org, read:project, read:user.

⚙️ Deploy Configurations

The above deploy button uses the following configurations.

Root Directory: leaderboard Build Command: pnpm build Install Command: ./pre-deploy.sh && pnpm install

🎨 Personalizing Leaderboard Deployment

Leaderboard can be personalized by editing the contents in config directory.

Theme and Colors Leaderboard has support for light and dark mode. To edit the theme colors, update the theme.css file.

Logo To change the favicon and logo, replace the files present in the config/assets directory with the desired ones.

leaderboard-org-data-template's People

Contributors

rithviknishad avatar

Watchers

syamkumar avatar Vignesh Hari 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.