https://github.com/tool3/contributions
github contribution visualization in 3D
https://github.com/tool3/contributions
glsl gsap nextjs react-three-fiber
Last synced: over 1 year ago
JSON representation
github contribution visualization in 3D
- Host: GitHub
- URL: https://github.com/tool3/contributions
- Owner: tool3
- Created: 2025-02-03T06:41:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T20:10:32.000Z (over 1 year ago)
- Last Synced: 2025-02-24T21:23:27.019Z (over 1 year ago)
- Topics: glsl, gsap, nextjs, react-three-fiber
- Language: TypeScript
- Homepage: https://g3v.vercel.app
- Size: 80.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# contributions
visualize your github contributions graph in 3D!
# Cool Features
- Fully customizable.
- Export to STL ascii or binary for 3D printing.
- Embed anywhere.
# Customizations
### theme
theme to be used throughout the app.
can be any hex color, minus the `#`.
for example: `https://g3c.vercel.app?username=tool3&theme=ccff00`
### menu
show or hide menu.
can be `true` or `false`.
for example: `https://g3c.vercel.app?username=tool3&menu=false`
### font
font to use for text.
can be `geistmono`, `grotesque`, `inter`, `monaspace`.
for example: `https://g3c.vercel.app?username=tool3&font=grotesque`
### material
material to use for bars and text.
can be `standard` or `matcap`.
for example: `https://g3c.vercel.app?username=tool3&material=matcap`
### matcap
matcap to be used for bars and text.
only applied if `material` is set to `matcap`.
use `matcap_` prefix and any number between 0 and 60.
for example: `https://g3c.vercel.app?username=tool3&material=matcap&matcap=matcap_33`
# Running locally
here are the steps to run this project locally:
1. clone this repo and npm install `git clone https://github.com/tool3/contributions && cd contributions/ && npm install`
2. create a `.env` file in the root directory of the project.
3. Add the following environment variables:
a. `NEXT_PUBLIC_SITE_URL=http://localhost:3000` - if a different port is used update here.
b. `GITHUB_TOKEN` - this should be a github access token with repo read.
For your convenience, change `` below to your github access token and copy this entire block into your terminal to run all of the above steps.
```bash
git clone https://github.com/tool3/contributions \
&& cd contributions/ \
&& npm install \
&& touch .env \
&& echo "NEXT_PUBLIC_SITE_URL=http://localhost:3000" >>> .env \
&& echo GITHUB_TOKEN= >>> .env
```
# Got a suggestion?
Open an issue! I'd love to hear your feedback!