kylemocode / medium-stat-box

📌 Medium Stat Box

Show your medium stat 😁
Including followers count and the title and claps of your latest articles

This project is inspired by many projects collected in awesome-pinned-gists

You can see example in my github pinned projects

Overview

This project uses Medium RSS API to get personal profile data and uses cheerio to crawl more details such as follower count and claps of articles. The following details will be displayed in pinned gist:

• Medium username and number of followers
• Latest 3 articles and their claps count

warning: medium articles with no categories will be filtered

Setup

Prep work

1. Create a new public GitHub Gist (https://gist.github.com/)
2. Create a token with the gist scope and copy it. (https://github.com/settings/tokens/new)

Project setup

1. Fork this repo

2. Go to the fork repo's Actions tab to enable workflow in fork repo

3. Go to the fork repo's Settings > Secrets

4. Add the following environment variables:

   • GH_PAT: The personal access token generated above.
   • GIST_ID: The ID portion from your gist url: ex: https://gist.github.com/kylemocode/ 44ccec1f7d16680a7a42a2e91a2d0d4c
   • MEDIUM_USER_NAME: The user name of your medium account ex: https://medium.com/@ oldmo860617

5. Pin your gist

6. Wait for it to update (the github aciton cron job will run every 8 hours), or you can manually push the repo to trigger the action.

Change Log

2021/10/14 : Update crawler regex for followers