├── .editorconfig
├── .env.template
├── .github
    └── workflows
    │   └── netlify.yml
├── .gitignore
├── .vscode
    └── settings.json
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── Makefile
├── README.md
├── _config.yml
├── _includes
    ├── head.html
    ├── header.html
    └── repo-card.html
├── _layouts
    └── default.html
├── _plugins
    ├── github_gql.rb
    ├── process.rb
    ├── repos_with_topics.gql
    ├── request.rb
    └── thousands-separated-filter.rb
├── _sass
    └── _overrides.scss
├── about.md
├── docs
    ├── README.md
    ├── deploy.md
    ├── development.md
    ├── installation.md
    ├── overview.md
    ├── requirements.md
    ├── token.md
    └── usage.md
├── favicon.ico
├── hooks
    └── pre-push
├── index.md
├── netlify.toml
├── package-lock.json
├── package.json
├── repos.md
├── sample-1.png
├── sample-2.png
└── topics.md


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | indent_style = space
 5 | indent_size = 2
 6 | 
 7 | [*.{md,html}]
 8 | indent_size = 4
 9 | 
10 | [{*.gql,Makefile}]
11 | indent_style = tab
12 | indent_size = 4
13 | 


--------------------------------------------------------------------------------
/.env.template:
--------------------------------------------------------------------------------
1 | GITHUB_TOKEN=
2 | 


--------------------------------------------------------------------------------
/.github/workflows/netlify.yml:
--------------------------------------------------------------------------------
 1 | name: Scheduled Netlify deploy
 2 | 
 3 | on:
 4 |   schedule:
 5 |     - cron: "0 0 * * *"
 6 |   workflow_dispatch:
 7 | 
 8 | jobs:
 9 |   deploy:
10 |     name: Deploy
11 | 
12 |     runs-on: ubuntu-latest
13 | 
14 |     steps:
15 |       - name: Request hook
16 |         run: curl -d '' https://api.netlify.com/build_hooks/${{ secrets.NETLIFY_HOOK_ID }}
17 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .jekyll-cache/
 2 | .jekyll-metadata
 3 | 
 4 | .bundle/
 5 | vendor/
 6 | 
 7 | node_modules/
 8 | assets/
 9 | 
10 | _site/
11 | 
12 | # Private auth token.
13 | .env
14 | 


--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "files.associations": {
 3 |     // Enable validation and highlighting.
 4 |     "*.html": "liquid",
 5 |     "index.md": "liquid",
 6 |     "about.md": "liquid",
 7 |     "repos.md": "liquid",
 8 |     "topics.md": "liquid"
 9 |   }
10 | }
11 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
 1 | source "https://rubygems.org"
 2 | 
 3 | gem "jekyll", "~> 4.2", ">= 4.2.0"
 4 | gem "webrick", "~> 1.8"
 5 | 
 6 | # Warning - in the start of 2020, Font Awesome was replaced, so from 0.9.0
 7 | # onwards the `fa` icons won't work.
 8 | # https://github.com/jekyll-octopod/jekyll-bulma/commits/master .
 9 | gem "jekyll-bulma", "0.8.1"
10 | 
11 | group :jekyll_plugins do
12 |   gem "jekyll-github-metadata", "~> 2.13", ">= 2.13.0"
13 |   gem "jekyll-sitemap", "~> 1.4", ">= 1.4.0"
14 |   gem "jekyll-seo-tag", "~> 2.7", ">= 2.7.1"
15 | 
16 |   gem "jemoji", "~> 0.12", ">= 0.12.0"
17 | 
18 |   gem "faraday", "~> 1.3"
19 |   gem "jekyll-timeago", "~> 0.13"
20 | end
21 | 
22 | gem "rufo", "~> 0.12.0", :group => :development
23 | 
24 | # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data
25 | # gem and associated library.
26 | platforms :mingw, :x64_mingw, :mswin, :jruby do
27 |   gem "tzinfo", "~> 1.2"
28 |   gem "tzinfo-data"
29 | end
30 | 
31 | # Performance-booster for watching directories on Windows
32 | gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
33 | 


--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
  1 | GEM
  2 |   remote: https://rubygems.org/
  3 |   specs:
  4 |     activesupport (7.0.7.2)
  5 |       concurrent-ruby (~> 1.0, >= 1.0.2)
  6 |       i18n (>= 1.6, < 2)
  7 |       minitest (>= 5.1)
  8 |       tzinfo (~> 2.0)
  9 |     addressable (2.8.1)
 10 |       public_suffix (>= 2.0.2, < 6.0)
 11 |     colorator (1.1.0)
 12 |     concurrent-ruby (1.2.2)
 13 |     em-websocket (0.5.3)
 14 |       eventmachine (>= 0.12.9)
 15 |       http_parser.rb (~> 0)
 16 |     eventmachine (1.2.7)
 17 |     faraday (1.10.0)
 18 |       faraday-em_http (~> 1.0)
 19 |       faraday-em_synchrony (~> 1.0)
 20 |       faraday-excon (~> 1.1)
 21 |       faraday-httpclient (~> 1.0)
 22 |       faraday-multipart (~> 1.0)
 23 |       faraday-net_http (~> 1.0)
 24 |       faraday-net_http_persistent (~> 1.0)
 25 |       faraday-patron (~> 1.0)
 26 |       faraday-rack (~> 1.0)
 27 |       faraday-retry (~> 1.0)
 28 |       ruby2_keywords (>= 0.0.4)
 29 |     faraday-em_http (1.0.0)
 30 |     faraday-em_synchrony (1.0.0)
 31 |     faraday-excon (1.1.0)
 32 |     faraday-httpclient (1.0.1)
 33 |     faraday-multipart (1.0.3)
 34 |       multipart-post (>= 1.2, < 3)
 35 |     faraday-net_http (1.0.1)
 36 |     faraday-net_http_persistent (1.2.0)
 37 |     faraday-patron (1.0.0)
 38 |     faraday-rack (1.0.0)
 39 |     faraday-retry (1.0.3)
 40 |     ffi (1.15.5)
 41 |     forwardable-extended (2.6.0)
 42 |     gemoji (4.0.1)
 43 |     html-pipeline (2.14.3)
 44 |       activesupport (>= 2)
 45 |       nokogiri (>= 1.4)
 46 |     http_parser.rb (0.8.0)
 47 |     i18n (1.14.1)
 48 |       concurrent-ruby (~> 1.0)
 49 |     jekyll (4.3.1)
 50 |       addressable (~> 2.4)
 51 |       colorator (~> 1.0)
 52 |       em-websocket (~> 0.5)
 53 |       i18n (~> 1.0)
 54 |       jekyll-sass-converter (>= 2.0, < 4.0)
 55 |       jekyll-watch (~> 2.0)
 56 |       kramdown (~> 2.3, >= 2.3.1)
 57 |       kramdown-parser-gfm (~> 1.0)
 58 |       liquid (~> 4.0)
 59 |       mercenary (>= 0.3.6, < 0.5)
 60 |       pathutil (~> 0.9)
 61 |       rouge (>= 3.0, < 5.0)
 62 |       safe_yaml (~> 1.0)
 63 |       terminal-table (>= 1.8, < 4.0)
 64 |       webrick (~> 1.7)
 65 |     jekyll-bulma (0.8.1)
 66 |       jekyll (~> 4.0)
 67 |     jekyll-github-metadata (2.14.0)
 68 |       jekyll (>= 3.4, < 5.0)
 69 |       octokit (~> 4.0, != 4.4.0)
 70 |     jekyll-sass-converter (2.2.0)
 71 |       sassc (> 2.0.1, < 3.0)
 72 |     jekyll-seo-tag (2.8.0)
 73 |       jekyll (>= 3.8, < 5.0)
 74 |     jekyll-sitemap (1.4.0)
 75 |       jekyll (>= 3.7, < 5.0)
 76 |     jekyll-timeago (0.14.0)
 77 |       mini_i18n (>= 0.8.0)
 78 |     jekyll-watch (2.2.1)
 79 |       listen (~> 3.0)
 80 |     jemoji (0.13.0)
 81 |       gemoji (>= 3, < 5)
 82 |       html-pipeline (~> 2.2)
 83 |       jekyll (>= 3.0, < 5.0)
 84 |     kramdown (2.4.0)
 85 |       rexml
 86 |     kramdown-parser-gfm (1.1.0)
 87 |       kramdown (~> 2.0)
 88 |     liquid (4.0.3)
 89 |     listen (3.7.1)
 90 |       rb-fsevent (~> 0.10, >= 0.10.3)
 91 |       rb-inotify (~> 0.9, >= 0.9.10)
 92 |     mercenary (0.4.0)
 93 |     mini_i18n (0.8.0)
 94 |     mini_portile2 (2.8.6)
 95 |     minitest (5.19.0)
 96 |     multipart-post (2.1.1)
 97 |     nokogiri (1.16.5)
 98 |       mini_portile2 (~> 2.8.2)
 99 |       racc (~> 1.4)
100 |     nokogiri (1.16.5-x86_64-linux)
101 |       racc (~> 1.4)
102 |     octokit (4.22.0)
103 |       faraday (>= 0.9)
104 |       sawyer (~> 0.8.0, >= 0.5.3)
105 |     pathutil (0.16.2)
106 |       forwardable-extended (~> 2.6)
107 |     public_suffix (5.0.1)
108 |     racc (1.7.3)
109 |     rb-fsevent (0.11.2)
110 |     rb-inotify (0.10.1)
111 |       ffi (~> 1.0)
112 |     rexml (3.3.9)
113 |     rouge (4.0.0)
114 |     ruby2_keywords (0.0.5)
115 |     rufo (0.12.0)
116 |     safe_yaml (1.0.5)
117 |     sassc (2.4.0)
118 |       ffi (~> 1.9)
119 |     sawyer (0.8.2)
120 |       addressable (>= 2.3.5)
121 |       faraday (> 0.8, < 2.0)
122 |     terminal-table (3.0.2)
123 |       unicode-display_width (>= 1.1.1, < 3)
124 |     tzinfo (2.0.6)
125 |       concurrent-ruby (~> 1.0)
126 |     unicode-display_width (2.3.0)
127 |     webrick (1.8.2)
128 | 
129 | PLATFORMS
130 |   ruby
131 |   x86_64-linux
132 | 
133 | DEPENDENCIES
134 |   faraday (~> 1.3)
135 |   jekyll (~> 4.2, >= 4.2.0)
136 |   jekyll-bulma (= 0.8.1)
137 |   jekyll-github-metadata (~> 2.13, >= 2.13.0)
138 |   jekyll-seo-tag (~> 2.7, >= 2.7.1)
139 |   jekyll-sitemap (~> 1.4, >= 1.4.0)
140 |   jekyll-timeago (~> 0.13)
141 |   jemoji (~> 0.12, >= 0.12.0)
142 |   rufo (~> 0.12.0)
143 |   tzinfo (~> 1.2)
144 |   tzinfo-data
145 |   wdm (~> 0.1.1)
146 |   webrick (~> 1.8)
147 | 
148 | BUNDLED WITH
149 |    2.1.4
150 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2020 - 2022 MichaelCurrin
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | SHELL = /bin/bash
 2 | JS_DIR = assets/js
 3 | export GITHUB_TOKEN
 4 | 
 5 | default: install
 6 | 
 7 | all: install build-dev
 8 | 
 9 | h help:
10 | 	@egrep '^[a-z -]+:' Makefile
11 | 
12 | 
13 | .PHONY: hooks
14 | hooks:
15 | 	cd .git/hooks && ln -s -f ../../hooks/pre-push pre-push
16 | 
17 | install-js:
18 | 	npm install
19 | 
20 | setup-js:
21 | 	rm -rf assets/*
22 | 	mkdir -p $(JS_DIR)
23 | 	cp node_modules/list.js/dist/* $(JS_DIR)
24 | 
25 | install-gems:
26 | 	bundle config set --local path vendor/bundle
27 | 	bundle install
28 | 
29 | install: install-js setup-js install-gems
30 | 
31 | upgrade:
32 | 	npm install list.js@latest
33 | 
34 | 	bundle clean
35 | 	bundle update
36 | 
37 | 	git status --short
38 | 
39 | 
40 | fmt:
41 | 	bundle exec rufo _plugins
42 | 
43 | 
44 | s serve: fmt
45 | 	source .env \
46 | 		&& bundle exec jekyll serve --trace --livereload
47 | 
48 | 
49 | build-dev:
50 | 	DEBUG=1 source .env \
51 | 		&& bundle exec jekyll build --trace
52 | 
53 | build-prod:
54 | 	JEKYLL_ENV=production bundle exec jekyll build --trace
55 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # My GitHub Projects
 2 | > Dev portfolio static site showing a user's GitHub repos grouped by topic
 3 | 
 4 | [![Netlify Status](https://api.netlify.com/api/v1/badges/43e6a441-a21b-4672-84be-e182a337e4cc/deploy-status)](https://app.netlify.com/sites/michael-currin/deploys)
 5 | [![Scheduled Netlify deploy](https://github.com/MichaelCurrin/my-github-projects/workflows/Scheduled%20Netlify%20deploy/badge.svg)](https://github.com/MichaelCurrin/my-github-projects/actions?query=workflow:"Scheduled+Netlify+deploy")
 6 | [![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/my-github-projects?include_prereleases&sort=semver)](https://github.com/MichaelCurrin/my-github-projects/releases/)
 7 | [![License](https://img.shields.io/badge/License-MIT-blue)](#license)
 8 | 
 9 | [![Made with Ruby](https://img.shields.io/badge/Ruby->=2.7-blue?logo=ruby)](https://www.ruby-lang.org)
10 | [![Made with Node.js](https://img.shields.io/badge/Node.js->=12-blue?logo=node.js&logoColor=white)](https://nodejs.org/)
11 | [![Uses GitHub GraphQL API](https://img.shields.io/badge/Made_with-GitHub_GraphQL_API-blue?logo=graphql&logoColor=white)](https://developer.github.com/v4/)
12 | 
13 | [![Made with Jekyll](https://img.shields.io/badge/jekyll-4.x-blue?logo=jekyll)](https://jekyllrb.com)
14 | [![Theme Jekyll Bulma](https://img.shields.io/badge/Theme-jekyll--bulma-blue)](https://github.com/jekyll-octopod/jekyll-bulma)
15 | [![Made with Bulma](https://img.shields.io/badge/Made_with-Bulma-blue?logo=bulma)](https://bulma.io/)
16 | [![Package - list.js](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/my-github-projects/list.js)](https://www.npmjs.com/package/list.js)
17 | [![Known Vulnerabilities gems](https://snyk.io/test/github/MichaelCurrin/my-github-projects/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/MichaelCurrin/my-github-projects?targetFile=Gemfile.lock)
18 | 
19 | 
20 | Showcase your GitHub repos as a statically-rendered site. Built on Jekyll and GitHub GraphQL API.
21 | 
22 | The project is deployed and hosted on Netlify. GitHub Actions is used to trigger a build daily, to ensure the latest repo info is used.
23 | 
24 | 
25 | ## Website
26 | 
27 | <div align="center">
28 | 
29 | [![view - Site](https://img.shields.io/badge/View_site-My_GitHub_Projects-2ea44f?style=for-the-badge&logo=netlify)](https://michael-currin.netlify.app)
30 | 
31 | </div>
32 | 
33 | 
34 | ## Preview
35 | 
36 | ### Repos
37 | 
38 | This page shows a list of all of the user's repos. With optional filter on name.
39 | 
40 | [![Sample screenshot 1](/sample-1.png)](https://michael-currin.netlify.app/repos/)
41 | 
42 | ### Topics
43 | 
44 | Show all repos grouped by topic (e.g. `#jekyll` or `#github-pages-site`).
45 | 
46 | [![Sample screenshot 2](/sample-2.png)](https://michael-currin.netlify.app/topics/)
47 | 
48 | 
49 | ## Setup your own portfolio
50 | 
51 | How to reuse this repo and to make portfolio site for yourself.
52 | 
53 | 1. Fork this repo to your own GitHub account.
54 | 2. Follow instructions in the docs for local or remote setup.
55 | 3. Make any custom updates like config values and making the doc badges point to your repo.
56 | 4. Comply with [License](#license) section below.
57 | 
58 | In the setup instructions, you'll generate a GitHub secret token for your account. The GitHub GraphQL query will then get data for you as the authenticating user. You do not have to set your own GitHub username anywhere.
59 | 
60 | 
61 | ## Documentation
62 | 
63 | <div align="center">
64 | 
65 | [![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/docs/)
66 | 
67 | </div>
68 | 
69 | 
70 | ## License
71 | 
72 | Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).
73 | 
74 | Feel free to use this project for your own portfolio - as a fork or a new project. Please add a link back to this repo.
75 | 
76 | If you use a significant portions of code for another project, you need to a copy of the original source in you repo.
77 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
 1 | ### Site metadata ###
 2 | 
 3 | title: My GitHub Projects
 4 | 
 5 | repository: MichaelCurrin/my-github-projects
 6 | author: Michael Currin
 7 | twitter_handle: MichaelCurrin
 8 | 
 9 | ### Build settings ###
10 | 
11 | url: https://michael-currin.netlify.app
12 | baseurl: ""
13 | 
14 | theme: jekyll-bulma
15 | 
16 | permalink: pretty
17 | 
18 | header_pages:
19 |   - repos.md
20 |   - topics.md
21 |   - about.md
22 | 
23 | collections:
24 |   topics:
25 |     output: true
26 | 
27 | liquid:
28 |   strict_filters: true
29 | 
30 | exclude:
31 |   - docs/
32 |   - LICENSE
33 |   - README.md
34 |   - Makefile
35 |   - netlify.toml
36 |   - package.json
37 |   - package-lock.json
38 | 


--------------------------------------------------------------------------------
/_includes/head.html:
--------------------------------------------------------------------------------
 1 | {% comment %}
 2 |     Based on jekyll-octopod/jekyll-bulma
 3 |     Note that the site url and base url logic was replaced with relative or absolute filters.
 4 | {% endcomment %}
 5 | <head>
 6 |     <meta charset="utf-8">
 7 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 8 | 
 9 |     {% seo %}
10 | 
11 |     <link href="{{ '/assets/fonts/ubuntu/ubuntu-v11-latin-ext_latin-regular.woff' | relative_url }}"
12 |         rel='stylesheet'
13 |         type='text/css'>
14 |     <link rel="stylesheet"
15 |         href="{{ '/assets/css/main.css' | relative_url }}">
16 |     <link rel="canonical"
17 |         href="{{ page.url | replace:'index.html','' | absolute_url }}">
18 | 
19 |     <script src="{{ '/assets/js/dropdown.js' | relative_url }}"></script>
20 |     {% comment %} Custom content {% endcomment %}
21 |     <script src="{{ '/assets/js/list.min.js' | relative_url }}"></script>
22 | </head>
23 | 


--------------------------------------------------------------------------------
/_includes/header.html:
--------------------------------------------------------------------------------
 1 | {%- comment -%} Based on jekyll-octopod/jekyll-bulma {%- endcomment -%}
 2 | <nav class="navbar is-light is-fixed-top" role="navigation" aria-label="main navigation">
 3 |     <div class="navbar-brand">
 4 |         <a class="navbar-item" href="{% link index.md %}">
 5 |             {{ site.title | upcase }}
 6 |         </a>
 7 | 
 8 |         {%- comment -%} Hamburger made of lines - nothing to customize here. {%- endcomment -%}
 9 |         <a role="button" class="navbar-burger" data-target="navMenu" aria-label="menu" aria-expanded="false">
10 |             <span aria-hidden="true"></span>
11 |             <span aria-hidden="true"></span>
12 |             <span aria-hidden="true"></span>
13 |         </a>
14 |     </div>
15 | 
16 |     <div class="navbar-menu" id="navMenu">
17 |         <div class="navbar-start">
18 |             {%- comment -%} From jekyll/minima. {%- endcomment -%}
19 |             {%- for path in site.header_pages -%}
20 |                 {%- assign my_page = site.pages | where: "path", path | first -%}
21 |                 {%- if my_page.title -%}
22 |                     <div class="navbar-item">
23 |                         <a href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
24 |                     </div>
25 |                 {%- endif -%}
26 |             {%- endfor -%}
27 |         </div>
28 |     </div>
29 | </nav>
30 | 


--------------------------------------------------------------------------------
/_includes/repo-card.html:
--------------------------------------------------------------------------------
 1 | <div class="card">
 2 |     <div class="card-content">
 3 |         <div class="media">
 4 |             <div class="media-left">
 5 |                 <i class="fab fa-github fa-3x"></i>
 6 |             </div>
 7 | 
 8 |             <div class="media-content">
 9 |                 <p class="title is-4 list-name" data-name="{{ repo.name }}">
10 |                     <a href="{{ repo.url }}">{{ repo.name }}</a>
11 |                 </p>
12 | 
13 |                 <p class="subtitle is-6">
14 |                     {% if repo.stars != 0 %}
15 |                         <a href="{{ repo.url }}/stargazers">
16 |                             <i class="fas fa-star"></i> {{ repo.stars }}
17 |                         </a>
18 |                     {% endif %}
19 | 
20 |                     {% if repo.forks != 0 %}
21 |                         <a href="{{ repo.url }}/network/members">
22 |                             <i class="fas fa-code-branch"></i> {{ repo.forks }}
23 |                         </a>
24 |                     {% endif %}
25 | 
26 |                     {% if repo.is_fork %}
27 |                         fork
28 |                     {% endif %}
29 |                 </p>
30 |             </div>
31 |         </div>
32 | 
33 |         <div class="content">
34 |             <p>{{ repo.description }}</p>
35 | 
36 |             <p>
37 |                 Commits: <b>{{ repo.total_commits | thousands_separated }}</b><br>
38 |                 Updated: <b>{{ repo.updated_at | timeago }}</b><br>
39 |                 Created: <b>{{ repo.created_at | date: '%b %Y' }}</b><br>
40 |             </p>
41 |         </div>
42 |     </div>
43 | </div>
44 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | {%- comment -%} Based on jekyll-octopod/jekyll-bulma - excluding footer {%- endcomment -%}
 2 | <!DOCTYPE html>
 3 | <html class="has-navbar-fixed-top">
 4 | {% include head.html %}
 5 | 
 6 | <body>
 7 |     {% include header.html %}
 8 | 
 9 |     <section id="main" role="main" class="section">
10 |         <div class="container content">
11 |             {{ content }}
12 |         </div>
13 |     </section>
14 | 
15 | </body>
16 | 
17 | </html>
18 | 


--------------------------------------------------------------------------------
/_plugins/github_gql.rb:
--------------------------------------------------------------------------------
 1 | # Query the API and make the results available as Liquid variables.
 2 | require_relative "process"
 3 | 
 4 | module GitHubGQL
 5 |   class Generator < Jekyll::Generator
 6 |     @@QUERY_PATH = "repos_with_topics.gql"
 7 | 
 8 |     def read_env()
 9 |       @disable_gql = ENV["DISABLE_GQL"]
10 |       @debug = ENV["DEBUG"]
11 | 
12 |       @token = ENV["GITHUB_TOKEN"]
13 |       unless @token
14 |         raise "GitHub API token must be set"
15 |       end
16 |     end
17 | 
18 |     def query
19 |       if @disable_gql
20 |         @repos = {}
21 |         @topics = {}
22 |       else
23 |         gh_api = Process::GitHubAPI.new(@token, @@QUERY_PATH, @debug)
24 |         @repos, @topics = gh_api.get_repos_and_topics
25 |       end
26 |     end
27 | 
28 |     def generate(site)
29 |       self.read_env
30 |       self.query
31 | 
32 |       site.data["all_repos"] = @repos
33 |       site.data["all_topics"] = @topics
34 |     end
35 |   end
36 | end
37 | 


--------------------------------------------------------------------------------
/_plugins/process.rb:
--------------------------------------------------------------------------------
  1 | # Query the GraphQL API and process the data.
  2 | require "json"
  3 | require_relative "request"
  4 | 
  5 | module Process
  6 |   def self.total_commits_of_repo(repo)
  7 |     # Get count of total commits, but allow branch to be not set for an empty repo edge-case.
  8 |     branch = repo["defaultBranchRef"]
  9 | 
 10 |     branch ? branch["commits"]["history"]["totalCount"] : 0
 11 |   end
 12 | 
 13 |   def self.topics_as_names(fetched_repo)
 14 |     topics = fetched_repo["repositoryTopics"]["nodes"]
 15 |     topics.map { |t| t["topic"]["name"] }
 16 |   end
 17 | 
 18 |   def self.repo_as_hash(repo, total_commits, topic_names)
 19 |     # We can't use symbols here as Jekyll can't handle symbols.
 20 |     # A class or struct was not practical so hash is used here.
 21 |     {
 22 |       "name" => repo["name"],
 23 |       "url" => repo["url"],
 24 |       "description" => repo["description"],
 25 |       "is_fork" => repo["isFork"],
 26 | 
 27 |       "created_at" => repo["createdAt"],
 28 |       "updated_at" => repo["updatedAt"],
 29 | 
 30 |       "stars" => repo["stargazers"]["totalCount"],
 31 |       "forks" => repo["forkCount"],
 32 |       "total_commits" => total_commits,
 33 | 
 34 |       "topics" => topic_names,
 35 |     }
 36 |   end
 37 | 
 38 |   class GitHubAPI
 39 |     @@API_URL = "https://api.github.com/graphql"
 40 | 
 41 |     def initialize(token, query_filename, debug)
 42 |       @headers = {
 43 |         'Authorization': "token #{token}",
 44 |         'Content-Type': "application/json",
 45 |       }
 46 |       @payload = format_payload(query_filename)
 47 |       @debug = debug
 48 | 
 49 |       @fetched_repos = []
 50 | 
 51 |       @repos = {}
 52 |       # Key must be topic name.
 53 |       # Value must be a hash, with key as repo name and value as hash of repo attributes.
 54 |       @topics = Hash.new { |hash, key| hash[key] = {} }
 55 |     end
 56 | 
 57 |     def request
 58 |       req = Request.new(@@API_URL, @headers, @payload)
 59 |       resp_data = req.query()
 60 |       user = resp_data["viewer"]
 61 | 
 62 |       @fetched_original_repos = user["originalRepos"]["nodes"]
 63 |       @fetched_forked_repos = user["forkedRepos"]["nodes"]
 64 |     end
 65 | 
 66 |     def format_payload(query_filename)
 67 |       query_path = File.join File.dirname(__FILE__), query_filename
 68 |       query_contents = File.open(query_path).read
 69 | 
 70 |       { 'query': query_contents }
 71 |     end
 72 | 
 73 |     def parse_repo(repo)
 74 |       if @debug == "2"
 75 |         puts "REPO RAW DATA"
 76 |         puts JSON.pretty_generate repo
 77 |       end
 78 | 
 79 |       total_commits = Process::total_commits_of_repo(repo)
 80 |       topic_names = Process::topics_as_names(repo)
 81 | 
 82 |       Process::repo_as_hash(repo, total_commits, topic_names)
 83 |     end
 84 | 
 85 |     def extract_repos_and_topics(fetched_repos)
 86 |       fetched_repos.each do |fetched_repo|
 87 |         if @debug
 88 |           puts "FETCHED #{fetched_repo["name"]}"
 89 |         end
 90 | 
 91 |         repo = self.parse_repo(fetched_repo)
 92 | 
 93 |         topic_names = Process::topics_as_names(fetched_repo)
 94 |         topic_names.each do |topic|
 95 |           if @debug
 96 |             puts "  TOPIC #{topic}"
 97 |           end
 98 | 
 99 |           @topics[topic][repo["name"]] = repo
100 |         end
101 | 
102 |         @repos[repo["name"]] = repo
103 |       end
104 |     end
105 | 
106 |     def get_repos_and_topics
107 |       self.request
108 |       self.extract_repos_and_topics(@fetched_original_repos)
109 |       self.extract_repos_and_topics(@fetched_forked_repos)
110 | 
111 |       [@repos, @topics]
112 |     end
113 |   end
114 | end
115 | 


--------------------------------------------------------------------------------
/_plugins/repos_with_topics.gql:
--------------------------------------------------------------------------------
 1 | # Public repos owned by the current user.
 2 | #
 3 | # Querying original and forked repos separately helps overcome the page limit of 100 somewhat,
 4 | # without implementing pages.
 5 | 
 6 | fragment Repos on RepositoryConnection {
 7 | 	nodes {
 8 | 		# Metadata
 9 | 		name
10 | 		url
11 | 		description
12 | 		isFork
13 | 
14 | 		# Dates
15 | 		createdAt
16 | 		updatedAt
17 | 
18 | 		# Counts
19 | 		stargazers {
20 | 			totalCount
21 | 		}
22 | 		forkCount
23 | 		defaultBranchRef {
24 | 			commits: target {
25 | 				... on Commit {
26 | 					history(first: 1) {
27 | 						totalCount
28 | 					}
29 | 				}
30 | 			}
31 | 		}
32 | 
33 | 		# TODO: use additional fields, at risk of request timeout.
34 | 		repositoryTopics(first: 100) {
35 | 			nodes {
36 | 				topic {
37 | 					name
38 | 					# stargazers {
39 | 					# 	totalCount
40 | 					# }
41 | 					# viewerHasStarred
42 | 				}
43 | 				#url
44 | 			}
45 | 		}
46 | 	}
47 | }
48 | 
49 | query ownedRepos {
50 | 	viewer {
51 | 		originalRepos: repositories(
52 | 			first: 100
53 | 			ownerAffiliations: OWNER
54 | 			privacy: PUBLIC
55 | 			isFork: false
56 | 			orderBy: { field: UPDATED_AT, direction: DESC }
57 | 		) {
58 | 			...Repos
59 | 		}
60 | 
61 | 		forkedRepos: repositories(
62 | 			first: 10 # Avoid timeout because I have so many forks.
63 | 			ownerAffiliations: OWNER
64 | 			privacy: PUBLIC
65 | 			isFork: true
66 | 			orderBy: { field: UPDATED_AT, direction: DESC }
67 | 		) {
68 | 			...Repos
69 | 		}
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/_plugins/request.rb:
--------------------------------------------------------------------------------
 1 | # Request module.
 2 | #
 3 | # Do a request to the GitHub GraphQL API and return data.
 4 | require "json"
 5 | require "faraday"
 6 | 
 7 | class Request
 8 |   def initialize(url, headers, payload)
 9 |     @url = url
10 |     @headers = headers
11 |     @payload = payload
12 |   end
13 | 
14 |   def post
15 |     puts "Do POST request"
16 |     resp = Faraday.post(
17 |       @url,
18 |       @payload.to_json,
19 |       @headers,
20 |     )
21 | 
22 |     puts "Status: #{resp.status}"
23 |     if resp.status > 299
24 |       puts "Body:"
25 |       puts resp.body
26 |       raise "Request status: #{resp.status}"
27 |     end
28 | 
29 |     JSON.parse resp.body
30 |   end
31 | 
32 |   def query()
33 |     results = self.post()
34 | 
35 |     errors = results["errors"]
36 |     if errors
37 |       puts "Errors on response:"
38 |       puts JSON.pretty_generate errors
39 |       raise "Request error!"
40 |     end
41 | 
42 |     results["data"]
43 |   end
44 | 
45 |   def test
46 |     data = self.query()
47 | 
48 |     puts "Pretty printed response"
49 |     puts JSON.pretty_generate data
50 |   end
51 | end
52 | 


--------------------------------------------------------------------------------
/_plugins/thousands-separated-filter.rb:
--------------------------------------------------------------------------------
 1 | # From: https://github.com/MichaelCurrin/Liquid-Thousands-Separated-Filter
 2 | module Jekyll
 3 |   module ThousandsSeparatedFilter
 4 |     def thousands_separated(input, separator = ",")
 5 |       input.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{separator}")
 6 |     end
 7 |   end
 8 | end
 9 | 
10 | Liquid::Template.register_filter(Jekyll::ThousandsSeparatedFilter)
11 | 


--------------------------------------------------------------------------------
/_sass/_overrides.scss:
--------------------------------------------------------------------------------
 1 | /** Basic **/
 2 | 
 3 | html {
 4 |   background-color: #333;
 5 | }
 6 | 
 7 | body {
 8 |   height: 100%;
 9 |   color: white;
10 | }
11 | 
12 | .content h1,
13 | .content h2,
14 | .content h3,
15 | .content h4 {
16 |   color: white;
17 | }
18 | 
19 | /* Using dark background means treating links differently in main.*/
20 | #main {
21 |   a {
22 |     color: cornflowerblue;
23 |   }
24 | 
25 |   a:hover {
26 |     color: lightskyblue;
27 |   }
28 | }
29 | 
30 | /* Use the theme's blue on the white bg cards. */
31 | .card {
32 |   a {
33 |     color: #3273dc;
34 |   }
35 | 
36 |   a:hover {
37 |     color: grey;
38 |   }
39 | }
40 | 
41 | /** List JS **/
42 | 
43 | /* For columns of cards, remove shadow mainly - override Bulma styling of `list` class, as this is used for ListJS. */
44 | .columns.list {
45 |   background-color: inherit;
46 |   border-radius: inherit;
47 |   box-shadow: inherit;
48 | }
49 | 
50 | /* Allow search bar to have a reasonable size - override Bulma setting of 100%. */
51 | .search.input {
52 |   width: inherit;
53 | }
54 | 


--------------------------------------------------------------------------------
/about.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: About
 3 | layout: page
 4 | ---
 5 | 
 6 | ## Why
 7 | 
 8 | This website is a showcase of my own repos and the topics they fit into. For my own ease of using in searching and comparing my projects and for sharing them with others beyond the limitations of the standard view of repos on a profile on GitHub.
 9 | 
10 | 
11 | ## Where
12 | 
13 | [![MichaelCurrin - my-github-projects](https://img.shields.io/static/v1?label=MichaelCurrin&message=my-github-projects&color=blue&logo=github)](https://github.com/MichaelCurrin/my-github-projects)
14 | 
15 | 
16 | ## What
17 | 
18 | This project a static website hosted on [Netlify](https://netlify.com) for free and uses the following tools:
19 | 
20 | - [![Made with Jekyll](https://img.shields.io/badge/Made_with-Jekyll-blue?logo=jekyll)](https://jekyllrb.com)
21 | - [![Jekyll theme](https://img.shields.io/badge/Theme-jekyll--bulma-blue)](https://github.com/jekyll-octopod/jekyll-bulma)
22 | - [![Made with Ruby](https://img.shields.io/badge/Made_with-Ruby-blue?logo=ruby)](https://www.ruby-lang.org)
23 | - [![Made with GitHub GQL](https://img.shields.io/badge/Made%20with-GitHub_GraphQL-blue?logo=graphql&logoColor=white)](https://developer.github.com/v4/)
24 | 
25 | 
26 | ## How
27 | 
28 | On build, a request is done to GitHub GraphQL API to get repos and their topic labels. For the All Topics page, the structure is inverted such that topics contain repos.
29 | 
30 | You can fork and reuse this project to make a site showing your own GitHub repos. Follow the repo's [README](https://github.com/MichaelCurrin/my-github-projects/blob/master/README.md).
31 | 
32 | 
33 | ## Background
34 | 
35 | The idea was inspired a quickstart dev portfolio that GitHub supplies:
36 | 
37 | - The original repo: [github/personal-website](https://github.com/github/personal-website)
38 | - My site, using a fork of the above: [michaelcurrin.github.io/](https://michaelcurrin.github.io/)
39 | 


--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | permalink: /
 3 | ---
 4 | ## Documentation
 5 | 
 6 | [![MichaelCurrin - my-github-projects](https://img.shields.io/static/v1?label=MichaelCurrin&message=my-github-projects&color=blue&logo=github)](https://github.com/MichaelCurrin/my-github-projects)
 7 | 
 8 | - [Overview](overview.md) - info about how this project works and its purpose.
 9 | - [Requirements](requirements.md) - Read this before you start.
10 | - [Installation](installation.md) - Install locally.
11 | - [Usage](usage.md) - Run locally.
12 | - [Deploy](deploy.md) - Setup and run on Netlify.
13 | - [Token](token.md) - Generate a GitHub access token.
14 | - [Development](development.md) - For understanding and changing this project.
15 | 


--------------------------------------------------------------------------------
/docs/deploy.md:
--------------------------------------------------------------------------------
 1 | # Deploy
 2 | 
 3 | 
 4 | ## Create a token
 5 | 
 6 | Follow the [Token](token.md) doc then continue below.
 7 | 
 8 | 
 9 | ## Setup Netlify
10 | 
11 | 1. Ensure you have the repo or a fork in your GitHub account.
12 | 2. Add the repo to your Netlify account.
13 | 3. Edit the deploy **environment** variables - add `GITHUB_TOKEN` and use your value.
14 | 4. Open the deployed URL.
15 | 
16 | Notes on the build command in [netlify.toml][] config:
17 | 
18 | - The _Jekyll_ install is automatic, so just the JS install is needed.
19 | - An `.env` file is not needed here, since using Netlify secrets.
20 | - Netlify does not use _Bundler_.
21 | 
22 | Note that _Node_ is already available on Netlify.
23 | 
24 | [netlify.toml]: https://github.com/MichaelCurrin/my-github-projects/blob/master/netlify.toml
25 | 
26 | ## Setup GitHub Pages
27 | 
28 | Note that this does **not build** to GitHub Pages.
29 | 
30 | You need to add a GitHub Actions workflow instead, which handles install and run steps and use of the token.
31 | 


--------------------------------------------------------------------------------
/docs/development.md:
--------------------------------------------------------------------------------
  1 | # Development
  2 | 
  3 | Notes for developing this project.
  4 | 
  5 | 
  6 | ## Background
  7 | 
  8 | This project was inspired by the listing of repository cards shown through [github/personal-website](https://github.com/github/personal-website) repo. That shows data for a couple of repos, using the [Jekyll GitHub Metadata plugin](https://github.com/jekyll/github-metadata) and GitHub REST API internally. The public repos output from the plugin covers repos in detail, but there is not topic data and the language labels are limited (they are inferred and they do not reflect the purpose or tooling of a project).
  9 | 
 10 | This _My GitHub Projects_ repo goes a step further by getting repos and their topics, then grouping them by their topics (labels set for a GitHub repo). This was made possible by create a plugin (in Ruby) and for efficiency this was done using the GitHub GraphQL API (such that one request returns 100 repos and their labels at once).
 11 | 
 12 | I did a proof-of-concept for a Ruby plugin for GraphQL request using this repo - [MichaelCurrin/github-gql-ruby](https://github.com/MichaelCurrin/github-gql-ruby). However, the two projects have diverged as I made more changes in this project than that one, until I can make that one installable or as a submodule + symlink into plugins directory. Also this portfolio site will be easier for me to maintain using a Ruby library for GraphQL or a Python script (which would write out a JSON file to be read as a data file by Jekyll).
 13 | I chose Ruby initially for interest so I could do something useful with Ruby but the solution is not so flexible for me.
 14 | 
 15 | 
 16 | ## Future development ideas
 17 | 
 18 | - [ ] Adding sorting of own repos by various fields.
 19 | - [ ] Add section to focus on chosen repos as a showcase.
 20 | - [ ] Add section to focus on chosen topics.
 21 | - [ ] Add images for topics.
 22 | - [ ] Show favorited repos, alone or by topic.
 23 | - [ ] Add paging to get more than 100 repos.
 24 | - [ ] Add GraphQL params on the payload for variables.
 25 | - [ ] Add use of language tag. See the original repo.
 26 | 
 27 | 
 28 | ## Query
 29 | 
 30 | I can't exclude archived repos in the query. There is a `isLocked` filter but this gives no results even though I have to archived repos.
 31 | 
 32 | I can still use `isArchived` as a field on a repo.
 33 | 
 34 | Both `pushedAt` and `updatedAt` give the same value I think for a push. But the `pushedAt` one doesn't count updating the repo setup on GitHub, meaning `updatedAt` will be more recent so I use that.
 35 | 
 36 | 
 37 | ## Access token
 38 | 
 39 | It could be possible to mark the token as _optional_ and return empty data in the custom plugin, but this causes issues in other parts which except a structure.
 40 | 
 41 | One way to reduce build time is to comment out the Jekyll GitHub Metadata Plugin from the gem file or to set the number of repos in the GQL query file to a low number.
 42 | 
 43 | To avoid your token being exposed in a PR build triggered by a malicious fork (which might add to the build command or `Makefile`, please keep your log visibility as **private** in your Netlify app's Deploy settings.
 44 | 
 45 | 
 46 | ## Styling
 47 | 
 48 | The [jekyll-octopod/jekyll-bulma](https://github.com/jekyll-octopod/jekyll-bulma) gem is used. This makes it easy to start using existing templating approach based on [Bulma](https://bulma.io/) component styling. It also means Bulma is instead and locked at a version, which was the main reason for using the theme here.
 49 | 
 50 | Bulma links:
 51 | 
 52 | - [Form controls](https://bulma.io/documentation/form/general/)
 53 | - [Panel](https://bulma.io/documentation/components/panel/) doc - for search bar.
 54 | 
 55 | 
 56 | ### CSS file
 57 | 
 58 | See the [SASS][] directory.
 59 | 
 60 | [SASS]: https://github.com/MichaelCurrin/my-github-projects/tree/master/_sass
 61 | 
 62 | This file shadows the name of an empty file in the theme, to ensure it gets processed. There may be
 63 | better ways but this works okay. This content is added to the main.css file created mostly from
 64 | Bulma content.
 65 | 
 66 | This is not ideal as it does not replace the existing rule (such as background color), but it does
 67 | appends at the bottom of the main.css, which still works. Maybe this could be split out further
 68 | using multiple files, variables and imports, but this works okay.
 69 | 
 70 | Maybe override in utilities/derived-variables. Or over variables before import is done, where color variables are used.
 71 | 
 72 | 
 73 | ## Reloading
 74 | 
 75 | At build time:
 76 | 
 77 | - GitHub metadata - A request is done to GitHub API through the Jekyll GitHub Metadata plugin, which adds `site.github` to the templating namespace. This includes details about the owner, the current repo (based on the remote origin if local) and public repos.
 78 | - GraphQL request - A request is done to GitHub GraphQL API using this project's custom plugin.
 79 | 
 80 | When saving changes to the repo, the server will restart. The GitHub metadata will not be fetched again but any changes to changes to templating will be applied. The GraphQL request will also be done - investigation could be done to avoid this happening.
 81 | 
 82 | 
 83 | ## Running scripts
 84 | 
 85 | The Ruby plugin script cannot be run directly, only through Jekyll. This seems to be a bug in one of the gems.
 86 | 
 87 | More specifically, it happens after `jekyll` is installed (it does install `eventmachine` in vendor but this can't pick it up).
 88 | 
 89 | ```sh
 90 | $ bundle exec ruby request.rb
 91 | ```
 92 | ```
 93 | Could not find eventmachine-1.2.7 in any of the sources
 94 | Run `bundle install` to install missing gems.
 95 | ```
 96 | 
 97 | This does not help:
 98 | 
 99 | ```ruby
100 | gem 'eventmachine', '1.2.7'
101 | ```
102 | 
103 | Update: Maybe adding `eventmachine` to Gemfile and bundle install would then help?
104 | 
105 | 
106 | ## Format Ruby scripts
107 | 
108 | ```sh
109 | $ make fmt
110 | ```
111 | 
112 | 
113 | ## Packages
114 | 
115 | ### list.js
116 | 
117 | Add live filtering to repos based on user search input.
118 | 
119 | - Docs - https://listjs.com
120 | - NPM - https://www.npmjs.com/package/list.js
121 | 
122 | 
123 | ### jemoji
124 | 
125 | - https://github.com/jekyll/jemoji
126 | 
127 | This adds support for emojis. This helps for processing emojis in descriptions. Unfortunately, while it processes something like `:shield:` it does not process others like `:badger:`. See the Badge Generator repo.
128 | 
129 | ### jekyll-timeago
130 | 
131 | - https://github.com/markets/jekyll-timeago
132 | 
133 | Adds support for showing a date as how long ago (e.g. `today` or `2 months and 2 days ago`). A downside of this is that `today` is relative to the build date and not the date for the viewer visiting the site, so this should go back to plain dates, or the site should rebuild more often.
134 | 
135 | ### jekyll-github-metadata
136 | 
137 | Take this out of `Gemfile` locally to avoid API rate limit warnings. You just won't get user profile data of the user, such as the logo.
138 | 


--------------------------------------------------------------------------------
/docs/installation.md:
--------------------------------------------------------------------------------
 1 | ## Installation
 2 | > How to setup the project locally
 3 | 
 4 | 
 5 | ## Install system dependencies
 6 | 
 7 | - Ruby and Bundler - follow this [gist](https://gist.github.com/3af38fca4e2903cdedfb8402c18b2936).
 8 | - Install Node.js - follow this [gist](https://gist.github.com/MichaelCurrin/aa1fc56419a355972b96bce23f3bccba).
 9 | 
10 | 
11 | ## Install project packages
12 | 
13 | Setup a hook to build before pushing.
14 | 
15 | ```sh
16 | $ make hooks
17 | ```
18 | 
19 | Install local packages - NPM packages in `node_modules` and gems in `vendor`.
20 | 
21 | ```sh
22 | $ make install
23 | ```
24 | 
25 | 
26 | ## Configure
27 | 
28 | 1. Make sure you generated a token as per the [Token](token.md) doc.
29 | 2. Create an dotenv file from the template.
30 |     ```sh
31 |     $ cp .env.template .env
32 |     ```
33 | 3. Open the `.env` file and add your secret token value and save the file.
34 | 
35 | The result will be something like:
36 | 
37 | - `.env`
38 |     ```sh
39 |     GITHUB_TOKEN=abcedf123
40 |     ```
41 | 
42 | This project has been set up to **ignore** this file, to prevent it being accidentally committed and shared publicly.
43 | 


--------------------------------------------------------------------------------
/docs/overview.md:
--------------------------------------------------------------------------------
 1 | # Overview
 2 | 
 3 | ## How it works
 4 | 
 5 | This project will show your GitHub account's public repos as a statically generated Jekyll site, both locally or on a remote location such as on Netlify. (This _could_ work also with GitHub Actions to run the custom plugins and Jekyll 4. See the [GitHub Actions](https://jekyllrb.com/docs/continuous-integration/github-actions/) section on Jekyll docs - then a schedule parameter could be used for nightly or weekly builds.)
 6 | 
 7 | The main limitation that the site has rebuilt in order to get the latest repos and topic tags, but that is easy enough to trigger a new build by hand occasionally on Netlify - command-line `curl` POST requests can even trigger a build. And also this project works best when you have a lot of repos (over 10) and also use detailed but consistent tags based on the use (tool / linter / static site) or tech used (programming language / library / host location).
 8 | 
 9 | 
10 | ## Purpose
11 | 
12 | This project is setup to show repo data for the **current authenticated GitHub user** (i.e. not other users). This is easy with the `jekyll-github-metadata` plugin, but that uses GitHub API version 3 and it does not handle labels. So through some Ruby plugin scripts, this project fetches 100 repos including topics on each and then build a object with topic labels on the outside and repos within.
13 | 
14 | You can **fork** this project and setup as a Netlify static site which shows your **own** repos and their topic labels. You just have to configure your secret token and the query will get your repos.
15 | 
16 | When setup as a website, this project can serve the following purposes for the owner:
17 | 
18 | - Quick reference to **find your own repos** by name and check their stats. With future development, you can find most recent, most starred, etc.
19 | - Group your repos by **topic**.
20 |     - This is is very useful as a portfolio for **job interviews**, since someone can for example see how many Machine Learning, Python and static site projects you have. They can see at a glance what **activity** there is (last updated, how many stars) and optionally click through to see the actual repo.
21 |     - This project is useful for maintaining or searching projects **for yourself**. For example if you want to find all your projects which are hosted on GitHub Pages or Netlify (assuming they are well-labelled). Or all the templates projects.
22 |     - If you want to teach someone about a language or tool and what to show them what you've made, you can guide them to certain topics.
23 | - This project gives you freedom to change the **styling** if you want to present the data in a different way.
24 | - After future development, you can highlight repos or topics to **guide visitors towards**, or help you get to your most important or frequently accesses areas first.
25 | 
26 | If you want to explore your _private_ repos only, change the `privacy` value in the GraphQL query from `PUBLIC` to `PRIVATE`. Though you might want to just build that locally to avoid sharing that data.
27 | 


--------------------------------------------------------------------------------
/docs/requirements.md:
--------------------------------------------------------------------------------
 1 | # Requirements
 2 | 
 3 | | Name                 | Purpose                                                                      |
 4 | | -------------------- | ---------------------------------------------------------------------------- |
 5 | | GitHub account       | Repos owned by your account will used for reporting.                         |
 6 | | [GitHub dev token][] | For GraphQL API requests. Only _read_ access to your public repos is needed. |
 7 | | [Netlify][] account  | Optionally used to deploy the site remotely.                                 |
 8 | | [Ruby][] >= 2.6      | Run the custom Jekyll [plugins][] - includes a query to the GitHub API.      |
 9 | | [Bundler][]          | Install project-scoped gems from the [Gemfile][].                            |
10 | | [Node][]             | Install and run project-scoped Node packages from the [package.json][].      |
11 | 
12 | This project will **not** work on GitHub Pages, unless you use GitHub Actions. Netlify is used here because it requires much less configuration than GitHub Actions.
13 | 
14 | [GitHub dev token]: https://github.com/settings/tokens
15 | [Netlify]: https://netlify.com
16 | [Ruby]: https://www.ruby-lang.org/en/
17 | [Node]: https://nodejs.org/
18 | [Bundler]: https://bundler.io/
19 | 
20 | [plugins]: https://github.com/MichaelCurrin/my-github-projects/tree/master/_plugins
21 | [package.json]: https://github.com/MichaelCurrin/my-github-projects/blob/master/package.json
22 | [Gemfile]: https://github.com/MichaelCurrin/my-github-projects/blob/master/Gemfile
23 | 


--------------------------------------------------------------------------------
/docs/token.md:
--------------------------------------------------------------------------------
 1 | # Token
 2 | > Create a GitHub API token
 3 | 
 4 | This project relies on create a GitHub API access token with read-only access to your own repos.
 5 |  The token is then sent to GitHub API on a POST request.
 6 | 
 7 | 
 8 | To set this up:
 9 | 
10 | 1. Open **Personal access tokens** page on your GitHub account.
11 |     1. Settings page.
12 |     2. Developer Settings.
13 |     3. [Tokens](https://github.com/settings/tokens) page.
14 | 2. Grant **read-only** permissions to your public repos.
15 |     - Tick the `public_repo` option only.
16 | 3. **Create** the token.
17 | 4. **Copy** the token value.
18 |     - The value will **not** be visible after you leave this screen, however, you can always regenerate the token value.
19 | 
20 | You may continue to the [Remote](remote.md) or local [Installation](installation.md) steps, where you will add the token to your secret environment variables.
21 | 


--------------------------------------------------------------------------------
/docs/usage.md:
--------------------------------------------------------------------------------
 1 | # Usage
 2 | > Run locally
 3 | 
 4 | 
 5 | ## Serve
 6 | 
 7 | Start the development server.
 8 | 
 9 | ```sh
10 | $ make serve
11 | ```
12 | 
13 | Open in the browser:
14 | 
15 | - http://localhost:4000/
16 | 
17 | 
18 | ## Build
19 | 
20 | Do a build with verbose logging.
21 | 
22 | ```sh
23 | $ make build-dev
24 | ```
25 | 
26 | 
27 | ## Disable fetch
28 | 
29 | Run the build or serve steps without fetching GraphQL API data.
30 | 
31 | ```sh
32 | $ DISABLE_GQL=1 make build-dev
33 | ```
34 | 
35 | This will be quicker to run and doesn't require auth set up (an empty `.env` file is needed at least). The rendered site will just be mostly empty.
36 | 
37 | 
38 | Note that the `github-metadata` plugin will still be used, to fetch user data like profile image. This doesn't require a token but will eventually get API rejects past the rate limiting threshold.
39 | 


--------------------------------------------------------------------------------
/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MichaelCurrin/my-github-projects/15f8b2f4efe98dd38f9f332d6c6ddc6bf110f97a/favicon.ico


--------------------------------------------------------------------------------
/hooks/pre-push:
--------------------------------------------------------------------------------
1 | #!/bin/sh -e
2 | 
3 | # On a feature branch that has no remote yet, this first part would fail.
4 | git pull --rebase || git pull --rebase origin master
5 | 
6 | make all
7 | 


--------------------------------------------------------------------------------
/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Home
 3 | layout: home
 4 | ---
 5 | 
 6 | # [{{ site.github.owner_name }}]({{ site.github.owner_url }})
 7 | 
 8 | ![GitHub profile icon]({{ site.github.owner_gravatar_url }})
 9 | 
10 | {{ site.github.owner.bio }}
11 | 


--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
 1 | [build]
 2 |   command = "make setup-js build-prod"
 3 |   publish = "_site"
 4 | 
 5 | 
 6 | # The `activesupport` gem needs this from v7 on.
 7 | [context.production]
 8 |   environment = { RUBY_VERSION = "2.7.0" }
 9 | 
10 | [context.deploy-preview]
11 |   environment = { RUBY_VERSION = "2.7.0" }
12 | 


--------------------------------------------------------------------------------
/package-lock.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "my-github-projects",
 3 |   "version": "0.10.2",
 4 |   "lockfileVersion": 2,
 5 |   "requires": true,
 6 |   "packages": {
 7 |     "": {
 8 |       "name": "my-github-projects",
 9 |       "version": "0.10.2",
10 |       "license": "MIT",
11 |       "dependencies": {
12 |         "list.js": "^2.3.1"
13 |       }
14 |     },
15 |     "node_modules/list.js": {
16 |       "version": "2.3.1",
17 |       "resolved": "https://registry.npmjs.org/list.js/-/list.js-2.3.1.tgz",
18 |       "integrity": "sha512-jnmm7DYpKtH3DxtO1E2VNCC9Gp7Wrp/FWA2JxQrZUhVJ2RCQBd57pCN6W5w6jpsfWZV0PCAbTX2NOPgyFeeZZg==",
19 |       "dependencies": {
20 |         "string-natural-compare": "^2.0.2"
21 |       },
22 |       "engines": {
23 |         "node": "^6.0 || ^8.0 || ^10.0 || ^12.0 || >=14"
24 |       }
25 |     },
26 |     "node_modules/string-natural-compare": {
27 |       "version": "2.0.3",
28 |       "resolved": "https://registry.npmjs.org/string-natural-compare/-/string-natural-compare-2.0.3.tgz",
29 |       "integrity": "sha512-4Kcl12rNjc+6EKhY8QyDVuQTAlMWwRiNbsxnVwBUKFr7dYPQuXVrtNU4sEkjF9LHY0AY6uVbB3ktbkIH4LC+BQ=="
30 |     }
31 |   },
32 |   "dependencies": {
33 |     "list.js": {
34 |       "version": "2.3.1",
35 |       "resolved": "https://registry.npmjs.org/list.js/-/list.js-2.3.1.tgz",
36 |       "integrity": "sha512-jnmm7DYpKtH3DxtO1E2VNCC9Gp7Wrp/FWA2JxQrZUhVJ2RCQBd57pCN6W5w6jpsfWZV0PCAbTX2NOPgyFeeZZg==",
37 |       "requires": {
38 |         "string-natural-compare": "^2.0.2"
39 |       }
40 |     },
41 |     "string-natural-compare": {
42 |       "version": "2.0.3",
43 |       "resolved": "https://registry.npmjs.org/string-natural-compare/-/string-natural-compare-2.0.3.tgz",
44 |       "integrity": "sha512-4Kcl12rNjc+6EKhY8QyDVuQTAlMWwRiNbsxnVwBUKFr7dYPQuXVrtNU4sEkjF9LHY0AY6uVbB3ktbkIH4LC+BQ=="
45 |     }
46 |   }
47 | }
48 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "my-github-projects",
 3 |   "version": "0.10.2",
 4 |   "description": "Dev portfolio static site showing a user's GitHub repos grouped by topic",
 5 |   "private": "true",
 6 |   "author": "MichaelCurrin",
 7 |   "license": "MIT",
 8 |   "dependencies": {
 9 |     "list.js": "^2.3.1"
10 |   }
11 | }
12 | 


--------------------------------------------------------------------------------
/repos.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Repos
 3 | layout: page
 4 | ---
 5 | 
 6 | This page shows all public GitHub repos which are owned by me.
 7 | 
 8 | <div id="repos">
 9 |     <div class="container">
10 |         <!-- Filter controls -->
11 |         <div class="field">
12 |             <p class="control has-icons-left">
13 |                 <input class="search input" type="text" placeholder="Search repo names">
14 |                 <span class="icon is-left">
15 |                     <i class="fas fa-search" aria-hidden="true"></i>
16 |                 </span>
17 |             </p>
18 |         </div>
19 |     </div>
20 | 
21 |     <br>
22 |     <br>
23 | 
24 |     <div class="container">
25 |         <div id="repo-cards" class="columns is-multiline list">
26 |             {% for repo_data in site.data.all_repos %}
27 |                 {% assign repo = repo_data[1] %}
28 |                 <div class="column is-3-widescreen is-4-desktop is-6-tablet is-8-mobile">
29 |                     {% include repo-card.html %}
30 |                 </div>
31 |             {% endfor %}
32 |         </div>
33 |     </div>
34 | 
35 | </div>
36 | 
37 | <script>
38 |         var options = {
39 |             valueNames: [
40 |                 {
41 |                     name: 'list-name',
42 |                     attr: 'data-name'
43 |                 }
44 |             ]
45 |         };
46 |         var userList = new List('repos', options);
47 | 
48 | </script>
49 | 


--------------------------------------------------------------------------------
/sample-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MichaelCurrin/my-github-projects/15f8b2f4efe98dd38f9f332d6c6ddc6bf110f97a/sample-1.png


--------------------------------------------------------------------------------
/sample-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MichaelCurrin/my-github-projects/15f8b2f4efe98dd38f9f332d6c6ddc6bf110f97a/sample-2.png


--------------------------------------------------------------------------------
/topics.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Topics
 3 | layout: page
 4 | ---
 5 | 
 6 | This page shows all my GitHub repos, grouped by the topics I've assigned to them.
 7 | 
 8 | {% assign sorted_topics = site.data.all_topics | sort %}
 9 | <div id='repo-topics'>
10 | {% for topic in sorted_topics %}
11 |     <div>
12 |         <a href="#topic-{{ topic[0] }}"><h2 id="topic-{{ topic[0] }}">&#35;{{ topic[0] }}</h2></a>
13 | 
14 |         {% assign repos = topic[1] %}
15 |         <div class="columns is-multiline">
16 |             {% for repo_data in repos %}
17 |                 {% assign repo = repo_data[1] %}
18 |                 <div class="column is-3-widescreen is-4-desktop is-6-tablet is-8-mobile">
19 |                     {% include repo-card.html %}
20 |                 </div>
21 |             {% endfor -%}
22 |         </div>
23 | 
24 |         <br>
25 |     </div>
26 | {% endfor %}
27 | </div>
28 | 


--------------------------------------------------------------------------------