https://github.com/sudiptob2/cf-stats

A github action based realtime Codeforces activity statistics card and badge generator for github readme
https://github.com/sudiptob2/cf-stats

badges codeforce-stats codeforces codeforces-api competitive-programming cp-badges github-readme-profile hacktoberfest hactoberfest2022 profile-card profile-readme programming-contests readme-template resume stat-images svg-card visualization

Last synced: 25 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sudiptob2/cf-stats
• Owner: sudiptob2
• License: gpl-3.0
• Created: 2022-08-13T10:21:20.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-04T14:55:57.000Z (3 months ago)
• Last Synced: 2025-04-29T20:12:48.159Z (25 days ago)
• Topics: badges, codeforce-stats, codeforces, codeforces-api, competitive-programming, cp-badges, github-readme-profile, hacktoberfest, hactoberfest2022, profile-card, profile-readme, programming-contests, readme-template, resume, stat-images, svg-card, visualization
• Language: Python
• Homepage:
• Size: 1.45 MB
• Stars: 220
• Watchers: 1
• Forks: 48
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Codeforces Stat Visualization




















# Installation

### For step-by-step screenshots go [here](docs/INSTALLATIONSTEPS.md) 

1. Star this repository :pray:

2. Create a copy of this repository by clicking

   [here](https://github.com/sudiptob2/cf-stats/generate). 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](config/.env.template) and put your codeforces handle in the `CF_HANDLE` key.

4. Go to the [Actions Page](../../actions?query=workflow%3A"Generate+Stats+Images") 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`](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.

   ```md

   ![](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)

   ```

   ```md

   ![](https://raw.githubusercontent.com/sudiptob2/cf-stats/main/output/max_rating.svg)

   ![](https://raw.githubusercontent.com/sudiptob2/cf-stats/main/output/rating.svg)

   ```

### Video Demonstration

  - [(हिन्दी)](https://www.youtube.com/watch?v=lPASqH0ZoIc)  Contributed by [shubhankarsharma876](https://github.com/shubhankarsharma876)

    

# Contribution guideline

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

the [contributing guidelines](docs/CONTRIBUTING.md).

# Acknowledgments

SVG design is contributed by [Nazmul Hasan](https://github.com/nazmulweb)