:octocat:The node version of github-profile-summary
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
config
server
src
static
.babelrc
.dockerignore
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.postcssrc.js
Dockerfile
LICENSE
README.md
app.js
index.html
jsconfig.json
now.json
package.json
pm2.json
yarn.lock

README.md

node-github-profile-summary

The node version of github-profile-summary which is inspired by tipsy' github-profile-summary

Site: https://gh-profile-summary.teamsz.xyz

Major skills or tools:

  • Vue
  • Chart.js
  • Koa
  • Github graphql api

Screenshot

Cool & beautiful profile list

Share system & Save your profile as Image

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:

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

git clone https://github.com/Molunerfinn/node-github-profile-summary.git
cd node-github-profile-summary
npm install # or yarn

Run

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

docker build -t github-profile .

Run

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

Copyright (c) 2018 Molunerfinn