Code Monkey home page Code Monkey logo

gitfaker's Introduction

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

gitfaker's People

Contributors

ericellb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

shmilyshirley

gitfaker's Issues

Missing ts-node dependency

When running the start command: npm start, the following output appeared:

sh: ts-node: command not found
npm ERR! code ELIFECYCLE
npm ERR! syscall spawn
npm ERR! file sh
npm ERR! errno ENOENT
npm ERR! [email protected] start: `ts-node src/index.ts`
npm ERR! spawn ENOENT
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

After installing ts-node globally (npm install -g ts-node), the previous command works.

Maybe it will be useful to add a line on the README to warn users to install this dependency.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.