Welcome to GitHub Graph Background 👋

A toy program for getting your GitHub Contributions and creating a background image from it with many themes.

Usage

npx @jckimble/github-graph-background

Options

Github Token can be read from the GITHUB_TOKEN Environment Variable

Option	Description	Default
--output	Image Output	./background.png
--width	Image Width	1366
--height	Image Height	768
--margin	Spacing Between Blocks	2
--token	GitHub Token	N/A
--theme	Color Theme	green

Themes

Special value of random picks a theme at random. Default theme is green. Current themes are: green, blue, red, rose, fullrandom and random along with their dark variants. Adding :dark after a theme name generates the dark version.

Green (green and green:dark)

Blue (blue and blue:dark)

Red (red and red:dark)

Rose (rose and rose:dark)

Full Random (fullrandom and fullrandom:dark)

From Source

Install

git clone https://github.com/jckimble/github-graph-background
cd github-graph-background
npm install

Usage

npm run start

Run tests

npm run test

Author

👤 James C Kimble Jr

• Website: https://jckimble.com
• Twitter: @jckimble601
• Github: @jckimble
• LinkedIn: @james-kimble-865092212

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

Donations

📝 License

Copyright © 2023 James C Kimble Jr.

This project is MIT licensed.