Skip to content

Forks the specified repositories in a known account.

License

Notifications You must be signed in to change notification settings

IonicaBizau/gh-fork

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh-fork

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Forks the specified repositories in a known account.

☁️ Installation

# Using npm
npm install --save gh-fork

# Using yarn
yarn add gh-fork

📋 Example

const ghFork = require("gh-fork");

// Fork everything from @jillix in @jxoss.
ghFork("jillix", "jxoss", "your token", function (err, data) {
    console.log(err || "Done");
}).on("repo-success", data => {
    console.log(`Forked ${data.source.full_name} into ${data.full_name}`);
}).on("repo-error", (err, c) => {
    console.log(`Failed to fork ${c.source.full_name}. Error: ${err}`);
});

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

ghFork(selector, where, token, cb)

Forks the specified repositories in a known account.

Params

  • String selector: If a GitHub owner (user or organization) is provided, all accesible repositories will be matched. If a repository full name is provided, only that specific repository will be matched.
  • String where: The account name where to fork the repositories (your username or an organization).
  • String token: The GitHub token.
  • Function cb: The callback function.

Return

  • EventEmitter An EventEmitter instance emitting the following events:
  • repo-error (err, repo): Emitted if the request failed for a specific repository.
  • repo-success (data, repo): Emitted the request is successful.
  • repo-progress (err, data): Emitted running the request to a repository (if it was a success, the error will be null).
  • done (err, data): Emitted after all the requests are executed.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

📜 License

MIT © Ionică Bizău

About

Forks the specified repositories in a known account.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published