/github-skyline

3D printable GitHub contributions graph as a skyline using three.js

Primary LanguageJavaScript

GitHub Skyline

Inspired by Github Skyline (2021, discontinued)

This repo is a fork of a fork of a fork of a fork of a fork of the original Github project replicated by github.com/jasonlong...


Features

  • Uses GitHub's GraphQL API to get up-to-date data

  • Renders GitHub contributions as a skyline using three.js

  • Exports as STL for 3D printing


Usage

  1. Clone the repo

  1. Edit the js/contributions.js file (line 8) and add your GitHub token:

    const config = {
      GITHUB_TOKEN: '<YOUR_GITHUB_TOKEN>'
    };

    You can create a GitHub token here.


  1. Run a local server:

    python -m http.server 8000
    

  1. Check your skyline at:

    http://localhost:8000/?username=<github_user>&year=<YYYY>
    

    Replace <github_user> and <YYYY>. Example:

    ?username=satelerd&year=2021