Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.95 KB

readme.md

File metadata and controls

59 lines (38 loc) · 1.95 KB

Git Faker

Git Faker is a tool that allows you to create fake Git Contribution history with custom Pixel Font messages.

This tool was created in order to make some cool custom swag using https://shop.devmugs.com/ or https://www.gitbrick.com/ (there are also various others)

This was not created in order to fool people that you code alot, and is not inteded to be used for malicious purposes.

sample image

Prerequisites

What things you need to install the software and how to install them

node

Using the Tool

In order to use the tool, clone the repository and start the program.

git clone https://github.com/ericellb/gitfaker
cd gitfaker
npm install
npm start

The tool will ask you for your Github Username, Email and Password. NONE of this information is stored, and it is only used by Github for authentication purposes. (If you are curious view the following file for is being done with the authentication information https://github.com/ericellb/gitfaker/blob/master/src/git.ts)

You must have a Git Repository on your Account with the name gitfaker

  1. Start the tool npm start
  2. Accept the warning, if you agree
  3. Enter a message of your choice
  4. Enter your Github Username / Email / Password
  5. Enjoy your new contribution history with your custom message!

Sample

? In order for this tool to work you must provide your Github Username, Email and Password. None of this information is stored. It's only used to create the commits.

 You must have a Git Repository created with the name 'gitfaker'

 Please confirm that you have read above, and have the Git Repository created [y/n] y


? Create your message! (max typically 8-11 chars) This is fun
? Github Username :  ericfakertest
? Github Email :  [hidden]
? Github Password :  [hidden]
Successfully created the message, check out your contribution history!

License

This project is licensed under the MIT License - see the LICENSE.md file for details