Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dyatko/worldstar
Generates world map chart of GitHub stargazers
https://github.com/dyatko/worldstar
chart github map stargazer statistics visualisation world
Last synced: about 2 months ago
JSON representation
Generates world map chart of GitHub stargazers
- Host: GitHub
- URL: https://github.com/dyatko/worldstar
- Owner: dyatko
- License: mit
- Created: 2019-03-21T14:09:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T13:38:12.000Z (6 months ago)
- Last Synced: 2024-04-24T04:11:48.665Z (5 months ago)
- Topics: chart, github, map, stargazer, statistics, visualisation, world
- Language: JavaScript
- Homepage: https://www.npmjs.com/worldstar
- Size: 2.17 MB
- Stars: 36
- Watchers: 1
- Forks: 2
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Generates world map chart of GitHub stargazers
These are first 5,000 stargazers of [D3](https://github.com/d3/d3), one of the major Worldstar dependencies.
### Usage
The tool requires few API keys from you:
- [GitHub API](https://github.com/settings/tokens)
- [Google Maps API](https://cloud.google.com/maps-platform/#get-started)
```console
user@machine:~$ npx worldstar --help
Options:
--version Show version number [boolean]
--help Show help [boolean]
--github-token GitHub token, alternatively GITHUB_TOKEN env var [required]
--google-token Google API token, alternatively GOOGLE_TOKEN env var[required]
--repo, -r GitHub repo to parse, e.g. dyatko/arkit [required]
--max, -m Maximum number of stargazers due to GitHub allows up to 5000
requests/hour [required] [default: 1000]
--color, -c Country color [required] [default: "#24292e"]
--output, -o Output path [required] [default: "worldstar.svg"]
```
```sh
# Run it straight away
npx worldstar --github-token=... --google-token=... --repo user/repo
# You can also pass secrets as environment variables
GITHUB_TOKEN=... GOOGLE_TOKEN=... npx worldstar --repo user/repo
# Or add it to your project as a dev dependency
npm install worldstar --save-dev
yarn add worldstar --dev
```
Besides nice SVG image, you will get some stats in your console:
```console
┌─────────┬──────┬───────┬────────┬────────┐
│ (index) │ name │ stars │ weight │ whiten │
├─────────┼──────┼───────┼────────┼────────┤
│ 0 │ 'US' │ 1696 │ 1 │ 0 │
│ 1 │ 'GB' │ 245 │ 0.97 │ 0.02 │
│ 2 │ 'DE' │ 237 │ 0.95 │ 0.03 │
│ 3 │ 'CN' │ 183 │ 0.92 │ 0.04 │
│ 4 │ 'CA' │ 168 │ 0.89 │ 0.05 │
│ 5 │ 'FR' │ 118 │ 0.86 │ 0.07 │
│ 6 │ 'AU' │ 103 │ 0.84 │ 0.08 │
│ 7 │ 'JP' │ 87 │ 0.81 │ 0.09 │
│ 8 │ 'BR' │ 75 │ 0.78 │ 0.11 │
│ 9 │ 'NL' │ 65 │ 0.76 │ 0.12 │
│ 10 │ 'IN' │ 56 │ 0.73 │ 0.14 │
│ 11 │ 'ES' │ 55 │ 0.7 │ 0.15 │
│ 12 │ 'RU' │ 53 │ 0.68 │ 0.16 │
│ 13 │ 'CH' │ 45 │ 0.65 │ 0.17 │
│ 14 │ 'SE' │ 41 │ 0.62 │ 0.19 │
│ 15 │ 'NO' │ 36 │ 0.59 │ 0.21 │
...
```
##### In case you wonder, the tool architecture diagram (generated by [arkit](https://github.com/dyatko/arkit))
