https://github.com/mbaraa/github-graph-drawer
A tool that helps typing text on your GitHub contributions graph.
https://github.com/mbaraa/github-graph-drawer
contribution-graph github go htmx
Last synced: 10 months ago
JSON representation
A tool that helps typing text on your GitHub contributions graph.
- Host: GitHub
- URL: https://github.com/mbaraa/github-graph-drawer
- Owner: mbaraa
- License: gpl-3.0
- Created: 2023-12-26T15:29:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-07T20:21:03.000Z (about 2 years ago)
- Last Synced: 2025-03-24T15:21:46.261Z (10 months ago)
- Topics: contribution-graph, github, go, htmx
- Language: Go
- Homepage: https://github-graph-drawer.mbaraa.xyz
- Size: 189 KB
- Stars: 20
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
GitHub Graph Drawer
A tool that helps typing text on your GitHub contributions graph.
## About
**GitHub Graph Drawer** is a tool that helps typing text on your GitHub contributions graph, where it helps you achieve your text goal by sending you emails through out the year for each day that you're supposed to make a log of commits at, or a cheat script that draws the text directly đź‘€.
_Note: this is a fling project that will die in a while so don't get your hopes up._
## Contributing
IDK, it would be really nice of you to contribute, check the poorly written [CONTRIBUTING.md](/CONTRIBUTING.md) for more info.
### Roadmap
- [x] Generator script
- [x] Web UI
- [x] SEO
- [x] Clear usage instructions
- [x] Commits count
- [x] Mailer
- [ ] Add more glyphs (symbols and things)
- [ ] Refactor the code (never gonna happen)
## Run locally
1. Clone the repo.
```bash
git clone https://github.com/mbaraa/github-graph-drawer
```
2. Create the docker environment file
```bash
cp .env .env.docker
```
3. Run it with compose.
```bash
docker compose up
```
3. Visit http://localhost:9999
4. Don't ask why I chose this weird port.
### Example
Here's my contributions graph showing "Hola Soy Baraa"
## Acknowledgements
- The “Paint brush” was downloaded from [flaticon.com](https://www.flaticon.com/free-icons/paint-brush)
- The “Beret” was downloaded from [flaticon.com](https://www.flaticon.com/free-icons/beret)
- The “Octocat” icon was downloaded [github.com/logos](https://github.com/logos)
- Well that’s it.