cf-stats icon indicating copy to clipboard operation
cf-stats copied to clipboard

A github action based realtime Codeforces activity statistics card and badge generator for github readme

Codeforces Stat Visualization


Installation

For step by step screenshot go here

  1. Star this repository :pray:

  2. Create a copy of this repository by clicking here. Note: this is not the same as forking a copy because it copies everything fresh, without the huge commit history.

  3. Goto config/.env.template and put your codeforces handle in the CF_HANDLE key.

  4. Go to the Actions Page and press "Run Workflow" on the right side of the screen to generate images for the first time.

    • The images will be automatically regenerated every 24 hours, but they can be regenerated manually by running the workflow this way.
  5. Take a look at the images that have been created in the output folder.

  6. To add your statistics to your GitHub Profile README, copy and paste the following lines of code into your markdown content. Change the your-github-username value to your GitHub username.

    ![](https://raw.githubusercontent.com/your-github-username/cf-stats/main/output/light_card.svg#gh-dark-mode-only)
    ![](https://raw.githubusercontent.com/your-github-username/cf-stats/main/output/light_card.svg)
    
    ![](https://raw.githubusercontent.com/sudiptob2/cf-stats/main/output/max_rating.svg)
    ![](https://raw.githubusercontent.com/sudiptob2/cf-stats/main/output/rating.svg)
    

Contribution guideline

If you like this project and want to improve by adding features, fixing bugs or anything, please follow the contributing guidelines.

Acknowledgments

Contributors List

Inspiration

This project is heavily inspired by github-stats project