Scrapping Good First Issues (#1010)

* initial setup

* pseudo code added

* pseudo code added for githubFunc.js

* token and repos from user's starred list added

* function to fetch issues added

* display of issues added

* formating added & method 3 done

* repo from trending on github added

* all 3 methods completed

* readme file updated

* token.js added

* minor refactoring

* package files from root removed and DB updated

* README and DB updated

Author: jhamadhav

JavaScript/Github_Good_First_Issues/DB.js

@@ -0,0 +1,13 @@
+let repoDB = [
+    {
+        "owner": "TesseractCoding",
+        "name": "NeoAlgo"
+    },
+    {
+        "owner": "HarshCasper",
+        "name": "Rotten-Scripts"
+
+    },
+]
+
+module.exports = repoDB;

JavaScript/Github_Good_First_Issues/Github_Good_First_Issues.js

@@ -0,0 +1,48 @@
+const prompt = require("prompt-sync")()
+const git = require("./githubFunc")
+const chalk = require("chalk")
+
+const printIssues = (arr) => {
+    for (let i = 0; i < arr.length; i++) {
+        console.log(chalk.yellow(`\n\n${i + 1}. ${arr[i]["repoOwner"]}/${arr[i]["repoName"]} (${chalk.white(arr[i]["issues"].length)}) : `))
+
+        let issues = arr[i]["issues"]
+        if (issues.length == 0) {
+            console.log(chalk.red("  None found!!"))
+            continue
+        }
+        for (let j = 0; j < issues.length; j++) {
+            console.log(chalk.blue(`\n  ${j + 1}. ${issues[j]["title"]} `))
+            console.log(`  URL: ${chalk.green(issues[j]["url"])} `)
+        }
+    }
+}
+
+const init = async () => {
+
+    console.log("\n================================")
+    console.log("----Github Good First Issues----")
+    console.log("================================\n")
+
+    console.log("1. DB file in the folder")
+    console.log("2. Trending page of Github")
+    console.log("3. Starred repo of an user")
+    let method = prompt("Choose method to fetch repo from: ")
+
+    let username = null;
+    if (Number(method) == 3) {
+        username = prompt("Enter github username : ")
+    }
+
+    console.log("\n...Fetching Data....Please wait...\n");
+    let repo = await git.getRepoViaMethod(method, username)
+    let issues = await git.getIssues(repo)
+
+    console.log(`\nINFO : ${chalk.yellow(repo.length)} repository(s) found!`);
+    printIssues(issues);
+
+    console.log("\n---END---\n");
+}
+
+// entry function
+init();

JavaScript/Github_Good_First_Issues/README.md

@@ -0,0 +1,47 @@
+# Github_Good_First_Issues
+
+- **Github_Good_First_Issues** is a script to scrap `Good First Issues` from GitHub Repositories.
+- It uses Github API to fetch repo and issues.
+- Then displays them to the user. 
+
+## Methods to fetch repositories
+
+There are 3 ways to fetch repositories
+1. `DB.js` file in the folder *(That can be overwritten by the user)*
+2. [Github Trending Page](https://github.com/trending)
+3. Starred repositories of a user *(User input)*
+
+## Setup instructions
+
+- Get your [`Github Developer Token`](https://dev.to/gr2m/github-api-authentication-personal-access-tokens-53kd) and follow the steps there to generate your **Token key**
+- In a file named `token.js` paste the token.
+- Open terminal and do the following : 
+- `cd Rotten-Scripts\JavaScript\Github_Good_First_Issues`
+- Run `npm install` to install all necessary dependencies
+- Run `node Github_Good_First_Issues.js` and Voila! you are ready to go 😉
+
+## Output
+
+### Method 1: via DB
+
+![ Method 1](https://i.imgur.com/eeAq9FN.png)
+
+### Method 2: Github Trending
+
+![ Method 2.1](https://i.imgur.com/HFlGh6j.png)
+![ Method 2.2](https://i.imgur.com/3u8hXnv.png)
+
+### Method 3: Starred repo(s) from user
+
+![ Method 3](https://i.imgur.com/WJaCm5F.png)
+
+## Author(s)
+
+Hi I'm [Madhav Jha](https://github.com/jhamadhav) author of this script.
+
+## Disclaimer
+
+### Why use the github token?
+
+It is true that github api is freely available for use by public but it is restricted to 60 requests per hour and for repositories with large number of issues this will exceed it's limit.
+So do get your [`Github Developer Token`](https://dev.to/gr2m/github-api-authentication-personal-access-tokens-53kd) before running this script

JavaScript/Github_Good_First_Issues/githubFunc.js

@@ -0,0 +1,99 @@
+const fetch = require("node-fetch")
+const githubToken = require("./token.js")
+const parser = require("node-html-parser")
+const db = require("./DB")
+
+const makeRequest = async (url) => {
+    let res = await fetch(url,
+        {
+            headers: {
+                authorization: `token ${githubToken.token}`
+            }
+        }
+    )
+    return res.json()
+}
+
+const fetchHtml = async () => {
+    let res = await fetch("https://github.com/trending")
+    let body = await res.text()
+    return body
+}
+
+const getRepoFromTrending = async () => {
+    let htmlData = await fetchHtml()
+    htmlData = parser.parse(htmlData);
+
+    let repoList = []
+    let articles = htmlData.querySelectorAll("article")
+    articles.forEach(element => {
+
+        let h1 = element.querySelectorAll("h1")[0]
+        let a = h1.querySelectorAll("a")[0]
+
+        let repoStr = a.innerText.trim();
+        repoStr = repoStr.split("/")
+
+        let owner = repoStr[0].trim()
+        let name = repoStr[1].replace("\n", "").trim()
+        let data = {
+            "owner": owner,
+            "name": name,
+            "url": `https://github.com/${owner}/${name}`
+        }
+        repoList.push(data)
+
+    });
+
+    return repoList
+}
+
+const getRepoFromStarred = async (username) => {
+    let repoList = await makeRequest(`https://api.github.com/users/${username}/starred`)
+    repoList = repoList.map(elem => {
+        return {
+            "owner": elem["owner"]["login"],
+            "name": elem["name"],
+            "url": elem["svn_url"]
+        }
+    })
+    return await repoList
+}
+
+const getRepoViaMethod = async (method, username) => {
+    method = Number(method)
+    if (method == 1) {
+        return db
+    } else if (method == 2) {
+        return getRepoFromTrending()
+    } else if (method == 3) {
+        return await getRepoFromStarred(username)
+    }
+    return []
+}
+
+const getIssues = async (arr) => {
+    let list = []
+    for (let i = 0; i < arr.length; i++) {
+
+        let url = `https://api.github.com/repos/${arr[i]["owner"]}/${arr[i]["name"]}/issues?labels=good first issue`
+
+        let issues = await makeRequest(url)
+        issues = issues.map(issue => {
+            return {
+                "title": issue["title"],
+                "url": issue["html_url"]
+            }
+        })
+
+        let data = {
+            "repoOwner": arr[i]["owner"],
+            "repoName": arr[i]["name"],
+            "issues": issues
+        }
+        list.push(data)
+    }
+    return list
+}
+
+module.exports = { getRepoViaMethod, getIssues }