Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/argon1025/github-user-stats-api
Unlimited open API for github User Stats
https://github.com/argon1025/github-user-stats-api
github nestjs-backend stats swagger-ui
Last synced: 28 days ago
JSON representation
Unlimited open API for github User Stats
- Host: GitHub
- URL: https://github.com/argon1025/github-user-stats-api
- Owner: argon1025
- Created: 2021-07-29T06:29:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-17T08:57:37.000Z (over 2 years ago)
- Last Synced: 2023-03-09T07:36:36.539Z (over 1 year ago)
- Topics: github, nestjs-backend, stats, swagger-ui
- Language: TypeScript
- Homepage: https://gitapi.tilog.io
- Size: 1010 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TILog client
Github User Stats API
We are creating blog services using this project Here
Issue
·
EndPoint Document
·
TILog Blog Project
# Project Status
Last Release Build : [](https://circleci.com/gh/argon1025/Github-User-Stats-API/tree/release)
# how It works?
Since the GitHub API only allows 5k requests per hour,
This Project Uses multiple tokens to bypass the Github requests limit.
# How To run
## 1. Clone this Project
```
git clone https://github.com/argon1025/Github-User-Stats-API.git
```
## 2. Move Project folder and Install npm module
```
cd Github-User-Stats-API
npm install
```
### 3. Create .ENV File
```
cd Github-User-Stats-API
vi .env
```
```
// .env
SERVER_PORT=8484
SERVER_HOST=localhost
GITHUB_TOKEN_1=asdhj123hg12ghj12gjh21g31hj23
GITHUB_TOKEN_2=fgh87fgh687hfg687hfg786fgh867
```
Enter as many Github tokens as you have. `GITHUB_TOKEN_${number}`
### 4. Start Server
```
npm run start:dev
```
# EndPoint
## 1. UserStats
### /stats/{username}
Request User Stats data
#### CURL
```
curl -X 'GET' \
'http://localhost/stats/{username}' \
-H 'accept: */*'
```
#### Response
```
{
"name": "Leeseongrok",
"totalPRs": 67,
"totalCommits": 1280,
"totalIssues": 108,
"totalStars": 5,
"contributedTo": 0
}
```
### /stats/{username}/top-language
Request User Top language data
#### CURL
```
curl -X 'GET' \
'http://localhost:8484/stats/{username}/top-language' \
-H 'accept: */*'
```
#### Response
```
{
"JavaScript": {
"name": "JavaScript",
"color": "#f1e05a",
"size": 389697
},
"TypeScript": {
"name": "TypeScript",
"color": "#2b7489",
"size": 147966
},
"Swift": {
"name": "Swift",
"color": "#ffac45",
"size": 74436
},
"Python": {
"name": "Python",
"color": "#3572A5",
"size": 30346
},
"Java": {
"name": "Java",
"color": "#b07219",
"size": 9330
},
}
```
## 2. Repositories
### /repo/{username}
Request All Repositories data
#### CURL
```
curl -X 'GET' \
'http://localhost:8484/repo/{username}' \
-H 'accept: */*'
```
#### Response
```
{
"name": "Babelfish_API",
"nameWithOwner": "argon1025/Babelfish_API",
"isPrivate": false,
"isArchived": false,
"isTemplate": false,
"stargazers": {
"totalCount": 2
},
"description": "Babelfish_API",
"primaryLanguage": {
"color": "#f1e05a",
"id": "MDg6TGFuZ3VhZ2UxNDA=",
"name": "JavaScript"
},
"forkCount": 0
}
```
### /repo/{username}?reponame={Repositories Name}
Request Repositories data
#### CURL
```
curl -X 'GET' \
'http://localhost:8484/repo/{username}?reponame={reponame}' \
-H 'accept: */*'
```
#### Response
```
{
"name": "Babelfish_API",
"nameWithOwner": "argon1025/Babelfish_API",
"isPrivate": false,
"isArchived": false,
"isTemplate": false,
"stargazers": {
"totalCount": 2
},
"description": "Babelfish_API",
"primaryLanguage": {
"color": "#f1e05a",
"id": "MDg6TGFuZ3VhZ2UxNDA=",
"name": "JavaScript"
},
"forkCount": 0
}
```
### /repo/{username}/pinned-repositories
Request pinned Repositories data
#### CURL
```
curl -X 'GET' \
'http://localhost:8484/repo/argon1025/pinned-repositories' \
-H 'accept: */*'
```
#### Response
```
[
{
"id": "MDEwOlJlcG9zaXRvcnkzMzA1OTM1MDc=",
"name": "Babelfish_API",
"nameWithOwner": "argon1025/Babelfish_API",
"isPrivate": false,
"isArchived": false,
"isTemplate": false,
"stargazers": {
"totalCount": 2
},
"description": "Babelfish_API",
"primaryLanguage": {
"color": "#f1e05a",
"id": "MDg6TGFuZ3VhZ2UxNDA=",
"name": "JavaScript"
},
"forkCount": 0
},
{
"id": "MDEwOlJlcG9zaXRvcnkzMzI3NTY4NTM=",
"name": "babelfish",
"nameWithOwner": "argon1025/babelfish",
"isPrivate": false,
"isArchived": false,
"isTemplate": false,
"stargazers": {
"totalCount": 1
},
"description": "Babelfish Frontend project with React",
"primaryLanguage": {
"color": "#f1e05a",
"id": "MDg6TGFuZ3VhZ2UxNDA=",
"name": "JavaScript"
},
"forkCount": 0
}
]
```
# +
> inspired by this project [here](https://github.com/anuraghazra/github-readme-stats)
>