https://github.com/Dhyeythumar/youtube-stats-card
🚀 Dynamic YouTube Stats Card for your github readmes & websites.
https://github.com/Dhyeythumar/youtube-stats-card
batches channel-card dynamic serverless stats video-card youtube-api-v3 youtube-stats youtube-stats-card youtubers
Last synced: 19 days ago
JSON representation
🚀 Dynamic YouTube Stats Card for your github readmes & websites.
- Host: GitHub
- URL: https://github.com/Dhyeythumar/youtube-stats-card
- Owner: dhyeythumar
- License: mit
- Created: 2020-12-05T07:26:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-13T03:47:47.000Z (over 3 years ago)
- Last Synced: 2024-08-03T23:15:48.362Z (10 months ago)
- Topics: batches, channel-card, dynamic, serverless, stats, video-card, youtube-api-v3, youtube-stats, youtube-stats-card, youtubers
- Language: JavaScript
- Homepage: https://youtube-stats-card.vercel.app/api?channelid=UCpKizIKSk8ga_LCI3e3GUig&layout=center&theme=dark_pink
- Size: 182 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-readme-tools - YouTube Stats Card - 🚀 Dynamic YouTube stats card for your github readmes. (Statistical Tools (Widgets))
README
YouTube Stats Card
Get dynamically generated YouTube Stats Cards for your github readmes & websites!
View Demo
·
Report Bug
·
Request Feature
## What’s In This Document
- [YouTube Channel Stats Card](#youtube-channel-stats-card)
- [Usage](#channel-usage)
- [Layout Demos](#channel-layout-demos)
- [Customization](#channel-customization)
- [Overview](#channel-overview)
- [YouTube Video Stats Card](#youtube-video-stats-card)
- [Usage](#video-usage)
- [Layout Demos](#video-layout-demos)
- [Customization](#video-customization)
- [Overview](#video-overview)
- [Contribution](./CONTRIBUTING.md)
- [Support the project](#support-the-project)
- [License](#license)
- [Acknowledgements](#acknowledgements)
## YouTube Channel Stats Card
#### **
Usage
**
```md
[](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig)
```
Change the `?channelid=` value to your YouTube Channel ID.
**[Check out this](https://github.com/Dhyeythumar/youtube-stats-card/discussions/1) to get your youtube channel id.**
#### **
Layout Demos
**
_Below layouts uses default parameters_\*
| Layouts | Preview |
| :-------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Default Layout | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Center Layout `&layout=center` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Exruded Layout `&layout=extruded` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
#### **
Customization
**
_All the Customizations are applied to the default layout_\*
| Parameters | Preview |
| :-------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Hide Icons `&hide_icons=true` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Hide Logo `&hide_logo=true` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Color Theme `&theme=THEME_NAME` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Hide Border `&hide_border=true` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Manual Color Theme `&title_color=cbf7db&icon_color=99ffbe`
`&text_color=fffefe&bg_color=40423e` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
| Custom Title `custom_title=My%20Channel%20Name` | [](https://www.youtube.com/channel/UCpKizIKSk8ga_LCI3e3GUig?sub_confirmation=1) |
[Check all the available color themes here](./themes/README.md) or checkout the [theme config file](./themes/index.js) & you can also contribute new themes if you like 🙂.
#### **
Overview
**
You can customize the appearance of your `Channel Stats Card` with following URL params:
- `hide_icons` - Hide the icons from channel card _(boolean)_
- `hide_logo` - Hide the logo from channel card _(boolean)_
- `theme` - Name of the theme, choose from [all available themes](./themes/README.md)
- `hide_border` - Hides the card's border _(boolean)_
- `title_color` - Card's title color _(hex color)_
- `text_color` - Body text color _(hex color)_
- `icon_color` - Icons color if available _(hex color)_
- `bg_color` - Card's background color _(hex color)_
- `custom_title` - Add custom title to the channel card **_(use %20 to add space)_**
- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_
> Note on cache: All cards have a default cache of 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
• • • •
## YouTube Video Stats Card
#### **
Usage
**
```md
[](https://youtu.be/4vwZNTagHsQ)
```
Change the `?videoid=` value to your youtube video ID.
**[Check out this](https://github.com/Dhyeythumar/youtube-stats-card/discussions/2) to get your youtube video id.**
#### **
Layout Demos
**
_Below layouts uses default parameters_\*
| Layouts | Preview |
| :------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Default Layout | [](https://youtu.be/4vwZNTagHsQ) |
| Compact Layout `&layout=compact` | [](https://youtu.be/4vwZNTagHsQ) |
#### **
Customization
**
_All the Customizations are applied to the default layout_\*
| Parameters | Preview |
| :-------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Hide Icons `&hide_icons=true` | [](https://youtu.be/4vwZNTagHsQ) |
| Hide Video Preview `&hide_preview=true` | [](https://youtu.be/4vwZNTagHsQ) |
| Color Theme `&theme=THEME_NAME` | [](https://youtu.be/4vwZNTagHsQ) |
| Hide Border `&hide_border=true` | [](https://youtu.be/4vwZNTagHsQ) |
| Manual Color Theme `&title_color=cbf7db&icon_color=99ffbe`
`&text_color=fffefe&bg_color=40423e` | [](https://youtu.be/4vwZNTagHsQ) |
| Hide Channel Name `&hide_channelname=true` | [](https://youtu.be/4vwZNTagHsQ) |
[Check all the available color themes here](./themes/README.md) or checkout the [theme config file](./themes/index.js) & you can also contribute new themes if you like 🙂.
#### **
Overview
**
You can customize the appearance of your `Video Stats Card` with following URL params:
- `hide_icons` - Hide the icons from video card _(boolean)_
- `hide_preview` - Hide the video preview from video card _(boolean)_
- `theme` - Name of the theme, choose from [all available themes](./themes/README.md)
- `hide_border` - Hides the card's border _(boolean)_
- `title_color` - Card's title color _(hex color)_
- `text_color` - Body text color _(hex color)_
- `icon_color` - Icons color if available _(hex color)_
- `bg_color` - Card's background color _(hex color)_
- `hide_channelname` - Hide the channel name in video card
- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_
> Note on cache: All cards have a default cache of 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
## Support the project
If you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
- Giving proper credit when you use youtube-stats-card on your readme.
- Starring and sharing the project.
If you would like to see a feature implemented, don't hesitate to add it to the issues list, or better is to create pull request 😎
Contributions are welcome!
## License
Licensed under the [MIT License](./LICENSE).
## Acknowledgements
Inspired by anuraghazra's [**github-readme-stats**](https://github.com/anuraghazra/github-readme-stats)