https://github.com/chadnpc/magf4svs

Created with StackBlitz ⚡️
https://github.com/chadnpc/magf4svs

Last synced: over 1 year ago
JSON representation

Created with StackBlitz ⚡️

• Host: GitHub
• URL: https://github.com/chadnpc/magf4svs
• Owner: chadnpc
• Created: 2025-01-06T20:25:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-06T20:41:11.000Z (over 1 year ago)
• Last Synced: 2025-02-10T01:31:39.510Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://stackblitz.com/edit/sb1-magf4svs
• Size: 159 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


![wakatime-charts](https://socialify.git.ci/dvjn/wakatime-charts/image?description=1&font=Inter&owner=1&pattern=Charlie%20Brown&theme=Light "wakatime charts")

![GitHub Repo stars](https://img.shields.io/github/stars/dvjn/wakatime-charts?color=%23dfb317&style=for-the-badge "Github Repo stars")

![GitHub forks](https://img.shields.io/github/forks/dvjn/wakatime-charts?color=%2397ca00&style=for-the-badge "Github forks")

![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/dvjn/wakatime-charts?color=%23fe7d37&label=PULLS&style=for-the-badge "Github pull requests")

---

![Weekly Language Stats](https://raw.githubusercontent.com/dvjn/wakatime-charts/master/images/wakatime_weekly_language_stats.svg "Weekly Language Stats")

![Weekly Project Stats](https://raw.githubusercontent.com/dvjn/wakatime-charts/master/images/wakatime_weekly_project_stats.svg "Weekly Project Stats")



## How to Use 🚀

### Set it up in your repository ⚙️

1. Add your wakatime api key from [here](https://wakatime.com/settings/api-key), in your repository secrets with the name `WAKATIME_API_KEY`.

2. **Optional:** If you are adding this action to a repository other than your profile repository (`/`), add your Github API Token from [here](https://github.com/settings/tokens), in your repository secrets with the name `GITHUB_TOKEN`.

3. Go to actions tab of your repository, click `New workflow`, and then click the link `set up a workflow yourself`.

4. Replace all the file contents with the following:

   ```yaml

   name: Wakatime Charts

   on:

     workflow_dispatch:

     schedule:

       - cron: "0 0 * * *"

   jobs:

     update-charts:

       name: Update wakatime stats charts

       runs-on: ubuntu-latest

       steps:

         - uses: dvjn/wakatime-charts@master

           with:

             WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}

             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # only required if using the action in repository other than profile

   ```

5. Commit this workflow file.

**Note:** The action will run at 00:00 UTC everyday to update the images.

### Other Parameters 🔧

- `BRANCH_NAME`: Set the branch on which charts are pushed. Defaults to `master`

- `COMMIT_MESSAGE`: Set the commit message for the changes. Defaults to `📊`

- `IMAGES_FOLDER`: Set the folder name in which generated images are stored. Defaults to `images`

- `GIT_USER_EMAIL`: Set the user email for git config. Defaults to Github Action Bot's email `41898282+github-actions[bot]@users.noreply.github.com`

- `GIT_USER_NAME`: Set the user name for git config. Defaults to `Github Action`

### Using generated images 🔗

Link for the generated images is:

`https://raw.githubusercontent.com/////.svg`

Where, the chart name is one of `wakatime_weekly_language_stats` and `wakatime_weekly_project_stats`.

## Inspiration 😍

- [wakatime-readme](https://github.com/marketplace/actions/waka-readme)

- [Profile-Readme-WakaTime](https://github.com/marketplace/actions/wakatime-stat-update-action)

- [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)