Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/k1ethoang/cf-stats
Owner: K1ethoang
License: gpl-3.0
Created: 2023-07-22T07:13:49.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-11-06T01:56:57.000Z (4 months ago)
Last Synced: 2024-11-06T02:41:00.884Z (4 months ago)
Language: Python
Size: 1.27 MB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Generate Stats Images](https://github.com/K1ethoang/cf-stats/actions/workflows/main.yml/badge.svg)](https://github.com/K1ethoang/cf-stats/actions/workflows/main.yml)

# Codeforces Stat Visualization




















# Installation

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

### Video Demonstration

  - [Hindi](https://www.youtube.com/watch?v=lPASqH0ZoIc)

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)

   ```

# 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

### Contributors List

- [Sudipto](https://github.com/sudiptob2)

- [Nazmul](https://github.com/nazmulweb)

- [Manish](https://github.com/csemanish12)

### Inspiration

This project is heavily inspired by [github-stats](https://github.com/jstrieb/github-stats) project