https://github.com/casperiv0/update-github-bio

Automatically updates your GitHub bio with your WakaTime stats every 15 minutes
https://github.com/casperiv0/update-github-bio

auto-update github-api

Last synced: 2 months ago
JSON representation

Automatically updates your GitHub bio with your WakaTime stats every 15 minutes

• Host: GitHub
• URL: https://github.com/casperiv0/update-github-bio
• Owner: casperiv0
• License: mit
• Created: 2020-11-28T19:16:31.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-10T23:08:19.000Z (12 months ago)
• Last Synced: 2024-10-04T16:16:09.440Z (3 months ago)
• Topics: auto-update, github-api
• Language: TypeScript
• Homepage:
• Size: 277 KB
• Stars: 12
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Update GitHub bio

Automatically updates your GitHub bio with your WakaTime stats every 15 minutes

![Showcase](./showcase.png)

## Installation

### Usage

1. Clone the repo: `git clone https://github.com/Dev-CasperTheGhost/update-github-bio`

2. Install the dependencies: `npm install`

3. Copy and rename `.env.example` to `.env`

4. Update your credentials in `.env`

   - GitHub token:  make sure to select the `user` scope

   - WakaTime api key: 

5. Build it! `npm run build`

6. Start it! `npm run start`

7. It should be running if nothing was returned!

### Running for 24/7

You can use [`pm2`](https://www.npmjs.com/package/pm2) to start this process in the background

1. Make sure that you have followed the steps above

2. Install pm2 globally: `npm install -g pm2`

3. Start it! `pm2 start npm --name github-bio -- run start`

## License

[MIT](./LICENSE)