Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kurt-liao/so-stats

Show your Stack Overflow Stats on your GitHub profile.
https://github.com/kurt-liao/so-stats

github github-readme-profile hacktoberfest javascript stackoverflow

Last synced: about 2 months ago
JSON representation

Show your Stack Overflow Stats on your GitHub profile.

Host: GitHub
URL: https://github.com/kurt-liao/so-stats
Owner: kurt-liao
License: mit
Created: 2022-06-08T16:00:55.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-10-28T07:35:05.000Z (about 2 years ago)
Last Synced: 2024-10-10T17:41:16.694Z (2 months ago)
Topics: github, github-readme-profile, hacktoberfest, javascript, stackoverflow
Language: JavaScript
Homepage: https://so-stats.vercel.app/api?user=10389571
Size: 256 KB
Stars: 12
Watchers: 3
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        



  

  Generate your reputation info in Stack Overflow on your README profile

  

  

  

  

  

  





   Issue 

  .

   Feature 

  .

   Blog 

  .

   Medium 



# Table of contents

1. [Usage](#usage)

2. [Optional](#optional)

    1. [Hide info](#hide-info)

    2. [Themes](#themes)

    3. [Random theme](#random-theme)

    4. [Locale](#locale)

    5. [Cache](#use-cache)

3. [Deploy](#deploy-your-own-)

4. [Contributors](#contributors)

## Usage

Easy to use! Ctrl + C + Ctrl + V to paste into your readme profile editor.

1. Find your Stack Overflow user id

2. Change the `?user=` value to your Stack Overflow user id.

```md

[![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571)](https://github.com/kurt-liao/so-stats)

```

[![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571)](https://github.com/kurt-liao/so-stats)

or

```html



  



```

 

  



Also you can see an example [here](https://github.com/kurt-liao/kurt-liao)

## Optional

### Hide info

You can pass a `&hide=` parameter with comma-seperated values.

> `&hide=title,logo,badges`

```md

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&hide=title,logo)

```

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&hide=title,logo)

### Themes

Finally, we have some inbuilt themes. Use `&theme=THEME_NAME` like:

```md

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&theme=greenery)

```

> Themes name we have: `greenery`, `forest`, `malt`, `azure` (Default theme don't need to assign).

#### All inbuilt themes

|  default   | greenery  | forest |

|  ----  | ----  | ---- |

| ![Default](https://so-stats.vercel.app/api?user=10389571) | ![Greenery](https://so-stats.vercel.app/api?user=10389571&theme=greenery) | ![Forest](https://so-stats.vercel.app/api?user=10389571&theme=forest) |

|  malt   | azure  | witch |

|  ----  | ----  | ---- |

| ![Malt](https://so-stats.vercel.app/api?user=10389571&theme=malt)  | ![Azure](https://so-stats.vercel.app/api?user=10389571&theme=azure) | ![Witch](https://so-stats.vercel.app/api?user=10389571&theme=witch)

### Random theme

You can pass a `&random=true` parameter to get different color style every time.

```md

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&random=true)

```

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&random=true)

### Locale

Support multi-language, use `&locale=` to set the locale you want.

At this moment, we support `en`, `cn`, `kr`, `zh-tw`, `nl`, `bn`, `de` . Default language is `en`.

### Use cache

You can pass a `&cache=true` parameter to set cache.

```md

![My Stack Overflow Stats](https://so-stats.vercel.app/api?user=10389571&cache=true)

```

## Deploy your own 🚀

   Guide 

- Fork this repo

- Sign up and log in into [Vercel](https://vercel.com/)

- Go to Vercel [dashboard](https://vercel.com/dashboard)

- Click `New Project`

- Click `Import Git Respository`(Of course you need to authorize the repo first, then you can see the repo in the list)

![2022-06-30_10-28](https://user-images.githubusercontent.com/32745146/176579816-2a28f1d5-2fd2-4218-8367-01a53dfcc09a.png)

- Click `delpoy`, and done. Find out your domain and start to use it!

- Add following command to prevent deploying on irrelevant changes.

![2022-06-30_10-17](https://user-images.githubusercontent.com/32745146/176579415-23ac711e-c695-4bad-aa85-1faf4ef67c67.png)



---

## Contributors

@see [CONTRIBUTING](/CONTRIBUTING.md)