github-graph-drawer
github-graph-drawer copied to clipboard
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 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
- Clone the repo.
git clone https://github.com/mbaraa/github-graph-drawer
- Create the docker environment file
cp .env .env.docker
- Run it with compose.
docker compose up
- Visit http://localhost:9999
- 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
- The “Beret” was downloaded from flaticon.com
- The “Octocat” icon was downloaded github.com/logos
- Well that’s it.
