Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 2.07 KB

README.md

File metadata and controls

89 lines (58 loc) · 2.07 KB
Raw

github-profile-chart

Visualize your github profile.

Inspired by Molunerfinn's node-github-profile-summary

Live at: http://ghprofile.breezymelon.com/

Features

  1. Responsive layout
  2. Simple and fresh interface
  3. Support exporting images

Skills & Dependencies

Screenshot

Take my account as an example, sorry for my poor github data.

Your beautiful profile

MrElvin's Github Profile

Save and Download your profile as an image

MrElvin's Github Profile Capture

Run locally

Project config

  1. First you should generate a github personal access token at https://github.com/settings/tokens

  2. Second you have to create a file in the project folder which name is project.config.json. For example:

{
  "PORT": 8080,
  "SOCKET_PORT": 3000,
  "JWT_SECRET": "github-profile-chart",
  "IS_STAR_REQUIRED": false,
  "TOKEN": "yourgithubpersonalaccesstoken"
}

  • PORT

    backend server port

  • SOCKET_PORT

    socket server port

  • JWT_SECRET

    any string you like (use for json web token)

  • IS_STAR_REQUIRED

    if this field is true, you can only analyze the gist who has starred the repository (Recommend: false)

  • TOKEN

    paste your github personal access token here

Install

git clone git@github.com:MrElvin/github-profile-chart.git
cd github-profile-chart
npm install

Run

npm run build
node app.js

Open http://localhost:3000 in your browser.

Enjoy ^_^

License

MIT