https://github.com/katt/gitkatt
👨🎤 create art in your github commit history
https://github.com/katt/gitkatt
Last synced: 3 months ago
JSON representation
👨🎤 create art in your github commit history
- Host: GitHub
- URL: https://github.com/katt/gitkatt
- Owner: KATT
- Created: 2017-12-12T10:58:48.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T15:33:23.000Z (over 2 years ago)
- Last Synced: 2025-05-08T01:14:29.291Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://github.com/KATT/gitkatt
- Size: 655 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub history art
Paint some sweet art in your GitHub commit history.
## [Example](https://github.com/KATT)
## HOW?!? 😻
1. [Create a personal API token](https://github.com/settings/tokens)
1. Run
```sh
npx gitkatt
```
1. (Optional): Update `./art` with other art
1. Follow the rest of steps
### Custom art
A file called `./art` will be created automatically with a template.
* any non-whitespace char gets filled
* the canvas is 7 in height (7 days)
### Optional: set default options
```sh
export GITHUB_USER='YOUR_GITHUB_USER'
export GITHUB_API_TOKEN='YOUR_GITHUB_API_TOKEN'
export DRAW_START_DATE='2017-02-26'
export ART_FILENAME='art'
```
### Notes
- Every time you run it it will delete (clears the graph) and create a repo called `gitkatt-child-repo` ([Example repo](https://github.com/KATT/gitkatt-child-repo)).
- The more layers you choose, the longer it'll run, & the darker your dots become.