Home

Awesome

node-github-profile-summary

<p align="center"> <img src="https://user-images.githubusercontent.com/12621342/35959365-41f352b0-0ce0-11e8-8a5b-05ad054ea378.png"> </p>

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:

Screenshot

Cool & beautiful profile list

Share system & Save your profile as Image

Local run

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

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.

Run

npm run build
npm start

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

TODOS

License

MIT

Copyright (c) 2018 Molunerfinn