My Github Projects
Dev portfolio static site showing a user's Github repos grouped by topic
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.
The main limitation that it has rebuilt in order to get the latest repos and topic tags though, but it is easy enough to trigger a new build by hand occasionally on Netlify. 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).
Purpose
This project is setup to show repo data for the current authenticated user (i.e. not other users).
When setup as a website of your own repos and their topics, this project can be used for the following:
- Quick reference to find your own repos by name and check their stats. With future development, you can find most recent, most starred, etc.
- Group your repos by topic.
- 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.
- 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.
- 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.
- This project gives you freedom to change the styling if you want to present the data in a different way.
- After future development, you can highlight repos or topics to guide visitors to, or help you get to your most important or frequently accesses areas first.
If you want to explore your private repos only, change the prviacy value in the GraphQL query from PUBLIC to PRIVATE. Though you might want to just build that locally to avoid sharing that data.
Background
This project was inspired by the listing of repository cards shown through github/personal-website repo. That shows data for a couple of repos, using the Jekyll Github Metadata plugin 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).
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).
Requirements
- Github account
- Github API dev token
- Ruby >= 2.4
- Bundler
This project uses Jekyll 4 - see Upgrading Jekyll.
Setup and run
See setup and run doc.
Development
See development docs.
Future development
- Adding sorting of own repos by various fields.
- Add section to focus on chosen repos as a showcase.
- Add section to focus on chosen topics.
- Add images for topics.
- Show favorited repos, alone or by topic.
- Add paging to get more than 100 repos.
- Add GraphQL params on the payload for variables.
- Add use of language tag. See the original repo.
License
See LICENSE.
Feel free to use this project for your own portfolio but please give credit in the repo and the website itself to this repo.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent