https://github.com/kylemocode/medium-stat-box

Practical pinned gist which show your latest medium status 📌
https://github.com/kylemocode/medium-stat-box

awesome-pinned-gists crawler github-action github-gists medium-stats

Last synced: 3 days ago
JSON representation

Practical pinned gist which show your latest medium status 📌

• Host: GitHub
• URL: https://github.com/kylemocode/medium-stat-box
• Owner: kylemocode
• License: mit
• Created: 2021-01-21T06:40:50.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-23T13:15:51.000Z (about 2 years ago)
• Last Synced: 2024-08-02T07:09:49.476Z (3 months ago)
• Topics: awesome-pinned-gists, crawler, github-action, github-gists, medium-stats
• Language: TypeScript
• Homepage:
• Size: 20.5 MB
• Stars: 37
• Watchers: 1
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pinned-gists - medium-stat-box - Update a pinned gist to show your medium stats and latest articles. (External Services)

README

        


   

  
📌 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](https://github.com/matchai/awesome-pinned-gists)

> You can see example in my [github pinned projects](https://github.com/kylemocode)

## Breaking Change

update at 2022/04/21.

Because medium change their website's structure, the old verison of this gist do not work, please pull the latest version of this action.

## 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](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)

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