Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/polatengin/prague

cli tool that estimates the value of a GitHub account
https://github.com/polatengin/prague

cli estimation github worth

Last synced: 15 days ago
JSON representation

cli tool that estimates the value of a GitHub account

Awesome Lists containing this project

README

        

# Prague project

_GitHubValue_ cli tool that estimates the value of a _GitHub_ account.

## Inputs

- `accountName`: GitHub account name.
- `--printRawJson` (_`--rawjson` `--json`_): Prints raw json data that's used to calculate _GitHub Account Value_.
- `--printEstimatedValue` (_`--estimatedvalue`, `--value`_): Prints _estimated value_ of the given _GitHub Account_.
- `--printFormula` (_`--formula`_): Prints _formula_ used to calculate _estimated value_ of the given _GitHub Account_.
- `--printVersion` (_`--version`_): Prints _version_ of the `prague` tool.

## Installation

Ensure `jq`, `debhelper`, `build-essentials`, `node v20` or newer is installed;

```bash
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y jq nodejs debhelper build-essential
```

Download latest version of `prague`;

```bash
sudo wget https://github.com/polatengin/prague/releases/download/0.0.4/prague-0.0.4.deb
```

Use `apt` command to start installation

```bash
sudo apt install -y ./prague-0.0.4.deb
```

## Compile, Test and Run

To compile the code, run the following command;

```bash
npm run build
```

To run tests, run the following command;

```bash
npm test
```

To run the code, run the following command;

```bash
npm run start -- polatengin --printFormula --printEstimatedValue --printRawJson
```

## Example Output

Run the following example command;

```bash
npm run start -- polatengin --printFormula --printEstimatedValue --printRawJson
```

Output;

```text
Raw JSON data:
{
"name": "polatengin",
"public_repos_count": 140,
"public_gists_count": 59,
"created_at": "2009-08-24T06:11:38.000Z",
"followers_count": 655,
"orgs": [
{
"name": "polatengin",
"public_repos_count": 140,
"public_gists_count": 59,
"created_at": "2009-08-24T06:11:38.000Z",
"followers_count": 655
},
{
"name": "microsoft",
"public_repos_count": 6421,
"public_gists_count": 0,
"created_at": "2013-12-10T19:06:48.000Z",
"followers_count": 76097
}
],
"repos": [
{
"name": "prague",
"stargazers_count": 1,
"watchers_count": 1,
"forks_count": 1,
"open_issues_count": 0,
"subscribers_count": 3,
"created_at": "2021-01-23T13:40:08.000Z"
},
{
"name": "tfs-cli",
"stargazers_count": 369,
"watchers_count": 369,
"forks_count": 132,
"open_issues_count": 138,
"subscribers_count": 106,
"created_at": "2015-07-22T09:23:42.000Z"
},
{
"name": "redmond",
"stargazers_count": 0,
"watchers_count": 0,
"forks_count": 0,
"open_issues_count": 0,
"subscribers_count": 1,
"created_at": "2024-09-26T18:37:36.000Z"
},
{
"name": "redmond-cd",
"stargazers_count": 0,
"watchers_count": 0,
"forks_count": 0,
"open_issues_count": 0,
"subscribers_count": 1,
"created_at": "2024-09-27T00:26:52.000Z"
},
{
"name": "vsts-extension-retrospectives",
"stargazers_count": 181,
"watchers_count": 181,
"forks_count": 80,
"open_issues_count": 215,
"subscribers_count": 22,
"created_at": "2020-03-30T14:12:34.000Z"
}
]
}

Estimated value:
$6003

Formula:
+ ($10 x 140) # public_repos_count x $10
+ ($5 x 59) # public_gists_count x $5
+ ($2 x 655) # followers_count x $2
+ ($3 x 551) # stargazers_count x $3
+ ($3 x 213) # forks_count x $3
- ($2 x 353) # open_issues_count x $2
= $6003
```