https://github.com/molunerfinn/node-github-profile-summary

[Temporarily unavailable]:octocat:The node version of github-profile-summary with GraphQL
https://github.com/molunerfinn/node-github-profile-summary

docker docker-support github-api github-profile graphql koa vue

Last synced: 6 days ago
JSON representation

[Temporarily unavailable]:octocat:The node version of github-profile-summary with GraphQL

• Host: GitHub
• URL: https://github.com/molunerfinn/node-github-profile-summary
• Owner: Molunerfinn
• License: mit
• Created: 2018-02-08T03:30:59.000Z (almost 7 years ago)
• Default Branch: dev
• Last Pushed: 2020-12-11T03:30:48.000Z (about 4 years ago)
• Last Synced: 2024-12-18T19:03:48.241Z (6 days ago)
• Topics: docker, docker-support, github-api, github-profile, graphql, koa, vue
• Language: JavaScript
• Homepage: https://gh-profile-summary.now.sh
• Size: 650 KB
• Stars: 262
• Watchers: 3
• Forks: 12
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-github-profile-summary



  



> The node version of github-profile-summary which is inspired by tipsy' [github-profile-summary](https://github.com/tipsy/github-profile-summary)

Site: https://gh-profile-summary.now.sh/

## Major skills or tools:

- Vue

- Chart.js

- Koa

- Github graphql api

## Screenshot

### Cool & beautiful profile list

![](https://user-images.githubusercontent.com/12621342/35951697-89e3338e-0cb7-11e8-9986-dc258f257b97.png)

### Share system & Save your profile as Image

![](https://user-images.githubusercontent.com/12621342/35951773-d1c9cf50-0cb7-11e8-80b2-08ae7d876533.png)

## Setup

First generate a token at https://github.com/settings/tokens

Then You need to create a `.env` file in the project folder.

The `.env` file looks like:

```env

GH_TOKEN=Your token here

JWT_SECRET=Any string

KOA_PORT=8888

HTTPS=false

```

> KOA_PORT can be any port you like which is available.

**If you set `HTTPS=true`, then the websocket will connect the 443 port, it's useful for https production.**

## Local run

### Node.js

> You need to have node environment!

### Install

``` bash

git clone https://github.com/Molunerfinn/node-github-profile-summary.git

cd node-github-profile-summary

npm install # or yarn

```

### Run

```bash

npm run build

npm start

```

**Notice:** 8888 is the `KOA_PORT` in `.env` file

And then open the link `http://localhost:8888`, Done.

### Docker 

> You need to have docker environment!

### Build

```bash

docker build -t github-profile .

```

### Run

```bash

docker run -it --rm --name github-profile -p 8888:8888 github-profile

```

**Notice:** 8888 is the `KOA_PORT` in `.env` file

And then open the link `http://localhost:8888`, Done.

## TODOS

- More useful charts

- ~~Docker support~~

- ...

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2018 Molunerfinn