Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacoblincool/leetcode-stats-card
Show your dynamically generated LeetCode stats on your GitHub profile or your website!
https://github.com/jacoblincool/leetcode-stats-card
card leetcode leetcode-stats profile serverless stats
Last synced: 1 day ago
JSON representation
Show your dynamically generated LeetCode stats on your GitHub profile or your website!
- Host: GitHub
- URL: https://github.com/jacoblincool/leetcode-stats-card
- Owner: JacobLinCool
- License: mit
- Created: 2021-06-11T10:43:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T19:21:28.000Z (10 months ago)
- Last Synced: 2024-04-23T14:05:29.140Z (9 months ago)
- Topics: card, leetcode, leetcode-stats, profile, serverless, stats
- Language: TypeScript
- Homepage: https://leetcard.jacoblin.cool
- Size: 1.24 MB
- Stars: 514
- Watchers: 7
- Forks: 60
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LeetCode Stats Card
[](https://www.codefactor.io/repository/github/jacoblincool/leetcode-stats-card)
Show your dynamically generated LeetCode stats on your GitHub profile or your website!
LeetCode and LeetCode CN are both supported.
[Playground: Try It Now](https://leetcard.jacoblin.cool/)
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=unicorn&extension=activity)
## Features
- 📈 Clean and simple LeetCode stats, for both `us` and `cn` sites
- 🎨 Multiple themes and 1,300+ fonts - [Theme](#theme-default-lightdark), [Font](#font-default-baloo_2)
- 🪄 Fully customizable using CSS - [Custom Stylesheets](#sheets-default-)
- ⚡️ Fast and global edge network - [Cloudflare Workers](https://workers.cloudflare.com/)
- 🚫 No tracking, controllable cache - [Cache](#cache-default-60)
- 🍀 Open source - [MIT License](./LICENSE)
- ⚙️ Extended-cards: `activity`, `contest`, `heatmap`
It also has a [NPM package](https://www.npmjs.com/package/leetcode-card) and a [highly extensible system](./packages/core/src/index.ts), so you can easily customize it to your needs.
Want to contribute? Feel free to open a pull request!
## Self-hosting
You can also self-host this service using the [`jacoblincool/leetcode-stats-card`](https://hub.docker.com/r/jacoblincool/leetcode-stats-card) Docker image.
To build the image by yourself, use `pnpm build:image` script.
See [docker-compose.yml](./docker-compose.yml) for an example.
## Usage
Simply copy the code below, paste it into your `README.md`, and change the path to your leetcode username (case-insensitive).
```md
```
Congratulation! You are now showing your LeetCode stats on your profile!
Want a hyperlink? Try this:
```md
[](https://leetcode.com/JacobLinCool)
```
### Endpoint
The endpoint of this tool is:
> The legacy one:
### Options
There are many options, you can configure them by passing a query string to the endpoint.
#### `site` (default: `us`)
Data source, can be `us` or `cn`.
```md
```
[](https://leetcard.jacoblin.cool/leetcode?site=cn)
#### `theme` (default: `light,dark`)
Card theme, see [Theme](#themes) for more information.
Use a comma to separate the light and dark theme.
```md
```
[](https://leetcode.com/jacoblincool)
#### `font` (default: `Baloo_2`)
Card font, you can use almost all fonts on [Google Fonts](https://fonts.google.com/).
It is case-insensitive, and you can use `font=dancing_script` or `font=Dancing%20Script` to get the same result.
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?font=Dancing_Script)
#### `width` and `height` (default: `500` and `200`)
Change the card size, it will not resize the content.
But it will be helpful if you want to use custom css.
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?width=500&height=500)
#### `border` and `radius` (default: `1` and `4`)
Change the card border and radius.
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?border=0&radius=20)
#### `animation` (default: `true`)
Enable or disable the animation.
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?animation=false)
#### `hide` (default: `""`)
Hide elements on the card, it is a comma-separated list of element ids.
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?hide=ranking,total-solved-text,easy-solved-count,medium-solved-count,hard-solved-count)
#### `ext` (default: `""`)
Extension, it is a comma-separated list of extension names.
NOTICE: You can only use one of extended-card extensions (`activity`, `contest`, `heatmap`) at a time now, maybe they can be used together in the future.
> Animation, font, theme, and external stylesheet are all implemented by extensions and enabled by default.
Want to contribute a `nyan-cat` extension? PR is welcome!
```md
```
[](https://leetcard.jacoblin.cool/jacoblincool?ext=activity)
```md
```
[](https://leetcard.jacoblin.cool/lapor?ext=contest)
```md
```
[](https://leetcard.jacoblin.cool/lapor?ext=heatmap)
#### `cache` (default: `60`)
Cache time in seconds.
Note: it will not be a good idea to set it to a long time because GitHub will fetch and cache the card.
```md
```
> You can make `DELETE` request to `/:site/:username` to delete the cache.
#### `sheets` (default: `""`)
External stylesheet, it is a comma-separated list of urls.
You can upload your custom CSS to gist and use the url.
```md
```
They will be injected in the order you specified.
#### Legacy Options
Still work, but deprecated.
| Key | Description | Default Value |
| --------------- | ---------------------------- | ------------- |
| `border_radius` | Same as `radius` | `4` |
| `show_rank` | Display/Hide Rank: `Boolean` | `true` |
| `extension` | Same as `ext` | `""` |
### Themes
Now we have 6 themes. If you have any great idea, please feel free to open a PR!
#### Light
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=light)
#### Dark
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=dark)
#### Nord
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=nord)
#### Forest
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=forest)
#### WTF
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=wtf)
#### Unicorn
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=unicorn)
#### Transparent
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?theme=transparent)
### Fonts
You can now use almost all fonts on [Google Fonts](https://fonts.google.com/).
Some examples:
#### Milonga
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?font=milonga)
#### Patrick Hand
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?font=patrick_hand)
#### Ruthie
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?font=ruthie)
### Extensions
Extension, it is a comma-separated list of extension names.
NOTICE: You can only use one of extended-card extensions (`activity`, `contest`, `heatmap`) at a time now, maybe they can be used together in the future.
> Animation, font, theme, and external stylesheet are all implemented by extensions and enabled by default.
Want to contribute a `nyan-cat` extension? PR is welcome!
#### `activity`
Show your recent submissions.
```md
```
[](https://leetcard.jacoblin.cool/JacobLinCool?ext=activity)
#### `contest`
Show your contest rating history.
```md
```
[](https://leetcard.jacoblin.cool/lapor?ext=contest)
#### `heatmap`
Show heatmap in the past 52 weeks.
```md
```
[](https://leetcard.jacoblin.cool/lapor?ext=heatmap)