https://github.com/yogeshwaran01/github-stats-terminal-style

Generate :octocat: Stats as like Terminal Interface with typing effects dynamically for your profile Readme
https://github.com/yogeshwaran01/github-stats-terminal-style

github github-stats github-stats-card javascript terminal

Last synced: 2 months ago
JSON representation

Generate :octocat: Stats as like Terminal Interface with typing effects dynamically for your profile Readme

• Host: GitHub
• URL: https://github.com/yogeshwaran01/github-stats-terminal-style
• Owner: yogeshwaran01
• License: mit
• Created: 2021-05-08T05:08:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T03:13:21.000Z (2 months ago)
• Last Synced: 2024-10-30T06:15:16.303Z (2 months ago)
• Topics: github, github-stats, github-stats-card, javascript, terminal
• Language: JavaScript
• Homepage:
• Size: 426 KB
• Stars: 216
• Watchers: 4
• Forks: 30
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• project-awesome - yogeshwaran01/github-stats-terminal-style - Generate :octocat: Stats as like Terminal Interface with typing effects dynamically for your profile Readme (JavaScript)
• awesome-readme-tools - GitHub Stats Terminal Style - Generate :octocat: Stats as like Terminal Interface with typing effects dynamically for your profile Readme (Miscellaneous)
• awesome-github-profile - Github Stats Terminal Style

README

        
GitHub Stats Terminal Style

Dynamically generate GitHub stats looking like a Terminal Interface 




  

    

  





  



## Usage

1. Create a new repository using this template or click [here](https://github.com/yogeshwaran01/github-stats-terminal-style/generate) to create.

2. Create the personal access token. Checkout this [link](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create a personal access token.

3. Add a new repository secret to your repo. The name of the secret must be `GHT` and the value is your personal access token (PAT). Checkout this [link](https://docs.github.com/en/actions/reference/encrypted-secrets) to add a new repository secret.

4. Enable `Allow GitHub Actions to create and approve pull requests` in General Action Settings

The file `github_stats.svg` is an svg image of your github stats. You can copy the link of the image and use it anywhere. By default it updates daily at `2:47 UTC`. You can also change this by changing the cron in `/.github/workflows/main.yml` by using [Cron Generator](https://crontab.guru/).

## Themes

Currently only nine themes are available. The default theme is the ubuntu theme. You can change the theme by changing the command in `/.github/workflows/main.yml`.

```bash

node updater.js ${{ github.repository_owner }} 

```

To use a random theme, do not specify any arguments.

|                           **Theme Sample**                            | **Theme Name** |         **Theme Sample**        |  **ThemeName** |

| :-------------------------------------------------------------------: | :------------: | :------------------------------:| :-------------: |

|            |     ubuntu     |   |   hacker   |

|                |      atom      |   |   googledark   |

|          |    default     |  |  googlelight   |

|          |    dracula     |      |    monokai     |

|            |     github     |   |   powershell   |

## Contributions

Contributions, issue and pull requests are welcome

## Credits

Svg Generated from [termtosvg](https://github.com/nbedos/termtosvg)