π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
β¨ Rebuilt the github stats widget for gh api
Alicia Sykesc083f5756a53
diff --git a/docs/privacy.md b/docs/privacy.mdindex 33f6f1ee..5eff15c6 100644--- a/docs/privacy.md+++ b/docs/privacy.md@@ -229,7 +229,7 @@ Dashy supports [Widgets](/docs/widgets.md) for displaying dynamic content. Below| [Flight Data](/docs/widgets.md#flight-data) | `https://aerodatabox.p.rapidapi.com` | [AeroDataBox Privacy Policy](https://www.aerodatabox.com/#h.p_CXtIYZWF_WQd) || [Astronomy Picture of the Day](/docs/widgets.md#astronomy-picture-of-the-day) | `https://apod.as93.net` | [NASA's Privacy Policy](https://www.nasa.gov/privacy/) (via a proxy run by Dashy's author) || [GitHub Trending](/docs/widgets.md#github-trending) | `https://trend.doforce.xyz` | No Policy Available |-| [GitHub Profile Stats](/docs/widgets.md#github-profile-stats) | `https://github-readme-stats.vercel.app` | [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement) |+| [GitHub Profile Stats](/docs/widgets.md#github-profile-stats) | `https://api.github.com` | [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement) || [Healthchecks Status](/docs/widgets.md#healthchecks-status) | `https://healthchecks.io` | [Health-Checks Privacy Policy](https://healthchecks.io/privacy/) || [Hacker News Trending](/docs/widgets.md#hackernews-trending) | `https://hacker-news.firebaseio.com` | [Y Combinator Privacy Policy](https://www.ycombinator.com/legal#privacy) || [Minecraft Server Status](/docs/widgets.md#minecraft-server) | `https://api.mcsrvstat.us` | No Policy Available |diff --git a/docs/widgets.md b/docs/widgets.mdindex 87804dc7..09aad081 100644--- a/docs/widgets.md+++ b/docs/widgets.md@@ -1189,7 +1189,7 @@ Displays currently trending projects on GitHub. Optionally specify a language an### GitHub Profile Stats-Display stats from your GitHub profile, using embedded cards from [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)+Displays a summary of a GitHub profile and its repositories, fetched directly from the [GitHub REST API](https://docs.github.com/en/rest). Shows a profile card (avatar, name and headline stats), followed by a card for each listed repository with its star, fork and issue counts.<p align="center"><img width="380" src="https://pixelflare.cc/alicia/dashy/github-stats" /></p>@@ -1197,10 +1197,10 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g**Field** | **Type** | **Required** | **Description**--- | --- | --- | ----**`username`** | `string` | Required | The GitHub username to fetch info for. E.g. `lissy93`. (Not required if `hideProfileCard` and `hideLanguagesCard` are both set to `true`)-**`hideProfileCard`** | `boolean` | _Optional_ | If set to `true`, the users profile card will not be shown. Defaults to `false`-**`hideLanguagesCard`** | `boolean` | _Optional_ | If set to `true`, the users top languages card will not be shown. Defaults to `false`-**`repos`** | `array` | _Optional_ | If you'd like to also display stats for some GitHub repositories, then add an array or repo names here. Specified as `[username]/[repo-name]`, e.g. `lissy93/dashy`+**`username`** | `string` | _Optional_ | The GitHub username to show the profile card for, e.g. `lissy93`. Required, unless `hideProfileCard` is set to `true`+**`hideProfileCard`** | `boolean` | _Optional_ | If set to `true`, the profile card is hidden, and only repositories are shown. Defaults to `false`+**`repos`** | `array` | _Optional_ | A list of repositories to show stats for, each specified as `[owner]/[repo]`, e.g. `lissy93/dashy`+**`token`** | `string` | _Optional_ | An optional [GitHub personal access token](https://github.com/settings/tokens). Used to raise the API rate limit from 60 to 5,000 requests per hour. Can be set directly, or as an environment variable#### Example@@ -1208,7 +1208,6 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g- type: github-profile-statsoptions:username: Lissy93- hideLanguagesCard: truerepos:- lissy93/dashy- lissy93/personal-security-checklist@@ -1218,9 +1217,9 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g#### Info- **CORS**: π’ Enabled-- **Auth**: π’ Not Required+- **Auth**: π‘ Optional (a `token` raises the rate limit)- **Price**: π’ Free-- **Host**: Managed Instance or Self-Hosted (see [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats))+- **Host**: GitHub ([docs.github.com/en/rest](https://docs.github.com/en/rest))- **Privacy**: _See [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement)_---diff --git a/src/assets/locales/en.json b/src/assets/locales/en.jsonindex ee63115a..3a9a75c1 100644--- a/src/assets/locales/en.json+++ b/src/assets/locales/en.json@@ -440,6 +440,14 @@"show-less": "Show Less","open-link": "Continue Reading"},+ "github-profile": {+ "repos": "Repos",+ "followers": "Followers",+ "following": "Following",+ "stars": "Stars",+ "forks": "Forks",+ "issues": "Issues"+ },"pi-hole": {"status-heading": "Status"},diff --git a/src/components/Widgets/GitHubProfile.vue b/src/components/Widgets/GitHubProfile.vueindex 494816bc..b20aacbc 100644--- a/src/components/Widgets/GitHubProfile.vue+++ b/src/components/Widgets/GitHubProfile.vue@@ -1,101 +1,291 @@<template>-<div class="readme-stats">- <a v-if="!hideProfileCard" :href="profileCardLink" target="_blank">- <img class="stats-card" :src="profileCard" alt="Profile Card" />+<div class="gh-stats">+ <!-- User profile card, with avatar and headline stats -->+ <a v-if="profile" class="profile-card" :href="profile.link" target="_blank">+ <img class="avatar" :src="profile.avatar" :alt="profile.login" />+ <div class="profile-info">+ <p class="name">{{ profile.name }}</p>+ <p class="login">@{{ profile.login }}</p>+ <p v-if="profile.bio" class="bio">{{ profile.bio }}</p>+ </div>+ <div class="headline-stats">+ <div v-for="stat in profile.stats" :key="stat.label" class="stat">+ <span class="num">{{ stat.value }}</span>+ <span class="label">{{ stat.label }}</span>+ </div>+ </div></a>- <a v-if="!hideLanguagesCard" :href="profileCardLink" target="_blank">- <img class="stats-card" :src="topLanguagesCard" alt="Languages" />+ <!-- One card per listed repository -->+ <a v-for="repo in repoCards" :key="repo.name" class="repo-card" :href="repo.link" target="_blank">+ <p class="repo-name">{{ repo.name }}</p>+ <p v-if="repo.description" class="repo-desc">{{ repo.description }}</p>+ <div class="repo-stats">+ <span v-if="repo.language" class="lang">+ <i class="dot" :style="{ background: repo.langColor }"></i>{{ repo.language }}+ </span>+ <span v-for="stat in repo.stats" :key="stat.label" class="stat" :title="stat.label">+ <svg class="icon" viewBox="0 0 16 16"><path fill-rule="evenodd" :d="stat.icon" /></svg>+ {{ stat.value }}+ </span>+ </div></a>- <template v-if="repos">- <a v-for="(repo, i) in repoCards" :key="i" :href="repo.cardHref" target="_blank">- <img class="stats-card" :src="repo.cardSrc" :alt="repo" />- </a>- </template></div></template><script>import WidgetMixin from '@/mixins/WidgetMixin';import { widgetApiEndpoints } from '@/utils/config/defaults';+import { formatNumber, truncateStr } from '@/utils/MiscHelpers';++// The star, fork and issue icons+const icons = {+ star: 'M8 .25a.75.75 0 0 1 .673.418l1.882 3.815 4.21.612a.75.75 0 0 1 .416 1.279l-3.046 2.97'+ + '.719 4.192a.751.751 0 0 1-1.088.791L8 12.347l-3.766 1.98a.75.75 0 0 1-1.088-.79l.72-4.194'+ + 'L.818 6.374a.75.75 0 0 1 .416-1.28l4.21-.611L7.327.668A.75.75 0 0 1 8 .25Z',+ fork: 'M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v'+ + '.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 '+ + '3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a'+ + '.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z',+ issue: 'M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3ZM8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 '+ + '6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z',+};++// Most common language colors, saves us needing to make second request+const langColors = {+ JavaScript: '#f1e05a', TypeScript: '#3178c6', Python: '#3572A5', Java: '#b07219',+ Go: '#00ADD8', Rust: '#dea584', C: '#555555', 'C++': '#f34b7d', 'C#': '#7355dd',+ Ruby: '#701516', PHP: '#4F5D95', Shell: '#89e051', HTML: '#e34c26', CSS: '#663399',+ SCSS: '#c6538c', Vue: '#41b883', Svelte: '#ff3e00', Astro: '#ff5a03', Swift: '#F05138',+ Kotlin: '#A97BFF', Dart: '#00B4AB', 'Objective-C': '#438eff', Scala: '#c22d40',+ Elixir: '#6e4a7e', Haskell: '#5e5086', Clojure: '#db5855', Lua: '#000080', Perl: '#0298c3',+ R: '#198CE7', Julia: '#a270ba', Zig: '#ec915c', Nix: '#7e7eff', Solidity: '#AA6746',+ Dockerfile: '#384d54', 'Jupyter Notebook': '#DA5B0B', PowerShell: '#012456',+ MDX: '#fcb32c', HCL: '#844FBA',+};export default {mixins: [WidgetMixin],+ data() {+ return {+ profile: null,+ repoCards: null,+ };+ },computed: {hideProfileCard() {- return this.options.hideProfileCard;- },- hideLanguagesCard() {- return this.options.hideLanguagesCard;+ return !!this.options.hideProfileCard;},username() {- const usersChoice = this.options.username;- if ((!this.hideProfileCard || !this.hideLanguagesCard) && !usersChoice) {- this.error('You must specify a GitHub username');- }- return usersChoice;+ return this.options.username;},repos() {const usersChoice = this.options.repos;- if (!usersChoice) return null;- if (typeof usersChoice === 'string') return [usersChoice];- if (Array.isArray(usersChoice)) return usersChoice;- this.error('Invalid format for repositories input');- return null;+ if (!usersChoice) return [];+ const list = Array.isArray(usersChoice) ? usersChoice : [usersChoice];+ return list.filter((repo) => typeof repo === 'string' && repo.includes('/'));},- colors() {- const cssVars = getComputedStyle(document.documentElement);- const getColor = (colorVar) => cssVars.getPropertyValue(`--${colorVar}`).trim().replace('#', '');- const primary = getColor('widget-text-color') || '7cd6fd';- const accent = getColor('widget-accent-color') || '7cd6fd';- const background = getColor('widget-background-color') || '7cd6fd';- const radius = getColor('curve-factor').replace('px', '') || '6';- const white = getColor('white') || 'fff';- return {- primary, accent, background, white, radius,- };+ token() {+ return this.options.token ? this.parseAsEnvVar(this.options.token) : null;},- locale() {- if (this.options.lang) return this.options.lang;- return this.$store.getters.appConfig.language || 'en';+ authHeaders() {+ return this.token ? { Authorization: `Bearer ${this.token}` } : null;},- cardConfig() {- const c = this.colors;- return `&title_color=${c.primary}&text_color=${c.white}&icon_color=${c.primary}`- + `&bg_color=${c.background}&border_radius=${c.radius}&locale=${this.locale}`- + '&count_private=true&show_icons=true&hide_border=true';+ },+ methods: {+ /* Validate options, then dispatch a request for the profile and each repo */+ fetchData() {+ if (!this.hideProfileCard && !this.username) {+ this.error('You must specify a GitHub username');+ this.finishLoading();+ return;+ }+ if (this.hideProfileCard && !this.repos.length) {+ this.error('Nothing to display, set a username or add repos');+ this.finishLoading();+ return;+ }+ if (!this.hideProfileCard) this.fetchProfile();+ if (this.repos.length) this.fetchRepos();},- profileCard() {- return `${widgetApiEndpoints.readMeStats}?username=${this.username}${this.cardConfig}`;+ /* Fetch the users profile for the top card */+ fetchProfile() {+ const endpoint = `${widgetApiEndpoints.githubApi}/users/${this.username}`;+ const notFound = `GitHub user '${this.username}' not found`;+ this.makeRequest(endpoint, this.authHeaders)+ .then((data) => { this.profile = this.formatProfile(data); })+ .catch((err) => this.handleApiError(err, notFound));},- profileCardLink() {- return `https://github.com/${this.username}`;+ /* Fetch each listed repo, keeping the users original order */+ fetchRepos() {+ const jobs = this.repos.map((repo) => {+ const endpoint = `${widgetApiEndpoints.githubApi}/repos/${repo}`;+ const notFound = `Repository '${repo}' not found`;+ return this.makeRequest(endpoint, this.authHeaders)+ .then(this.formatRepo)+ .catch((err) => { this.handleApiError(err, notFound); return null; });+ });+ Promise.all(jobs).then((cards) => { this.repoCards = cards.filter(Boolean); });},- topLanguagesCard() {- return `${widgetApiEndpoints.readMeStats}/top-langs/?username=${this.username}`- + `${this.cardConfig}&langs_count=12`;+ formatProfile(data) {+ return {+ avatar: data.avatar_url,+ name: data.name || data.login,+ login: data.login,+ bio: data.bio ? truncateStr(data.bio, 100) : null,+ link: data.html_url,+ stats: [+ { label: this.$t('widgets.github-profile.repos'), value: formatNumber(data.public_repos) },+ { label: this.$t('widgets.github-profile.followers'), value: formatNumber(data.followers) },+ { label: this.$t('widgets.github-profile.following'), value: formatNumber(data.following) },+ ],+ };},- repoCards() {- const cards = [];- this.repos.forEach((repo) => {- const username = repo.split('/')[0];- const repoName = repo.split('/')[1];- cards.push({- cardSrc: `${widgetApiEndpoints.readMeStats}/pin/?username=${username}`- + `&repo=${repoName}${this.cardConfig}&show_owner=true`,- cardHref: `https://github.com/${username}/${repoName}`,- });- });- return cards;+ formatRepo(data) {+ return {+ name: data.full_name,+ description: data.description ? truncateStr(data.description, 100) : null,+ link: data.html_url,+ language: data.language,+ langColor: langColors[data.language] || 'var(--widget-text-color)',+ stats: [+ { label: this.$t('widgets.github-profile.stars'), icon: icons.star, value: formatNumber(data.stargazers_count) },+ { label: this.$t('widgets.github-profile.forks'), icon: icons.fork, value: formatNumber(data.forks_count) },+ { label: this.$t('widgets.github-profile.issues'), icon: icons.issue, value: formatNumber(data.open_issues_count) },+ ],+ };+ },+ /* Display error message when error happens */+ handleApiError(err, notFoundMsg) {+ const res = err && err.response;+ const status = res?.status || res?.data?.error?.status;+ if (status === 401) {+ this.error('Invalid GitHub token');+ }+ else if (status === 403 || status === 429) {+ this.error('GitHub API rate limit reached, add a token or try again later');+ }+ else if (status === 404) {+ this.error(notFoundMsg);+ }+ else if (status >= 500) {+ this.error('GitHub is currently unavailable, try again later');+ }},},};</script><style scoped lang="scss">-.readme-stats {- img.stats-card {- width: 100%;+.gh-stats {+ display: flex;+ flex-direction: column;+ gap: 0.5rem;++ a {+ color: var(--widget-text-color);+ text-decoration: none;+ }++ // Top user profile card+ .profile-card {+ display: grid;+ grid-template-columns: auto 1fr;+ align-items: center;+ gap: 0.25rem 0.75rem;++ .avatar {+ width: 3.5rem;+ height: 3.5rem;+ border-radius: 50%;+ }+ .profile-info {+ p { margin: 0; }+ .name {+ font-size: 1.2rem;+ font-weight: bold;+ }+ .login {+ font-size: 0.9rem;+ opacity: var(--dimming-factor);+ }+ .bio {+ margin-top: 0.2rem;+ font-size: 0.8rem;+ }+ }+ .headline-stats {+ grid-column: 1 / -1;+ display: flex;+ justify-content: space-around;+ margin-top: 0.25rem;+ .stat {+ display: flex;+ flex-direction: column;+ align-items: center;+ .num {+ font-size: 1.1rem;+ font-weight: bold;+ font-family: var(--font-monospace);+ }+ .label {+ font-size: 0.7rem;+ text-transform: uppercase;+ opacity: var(--dimming-factor);+ }+ }+ }+ }++ // Per-repo card, separated by a dashed divider+ .repo-card:not(:first-child) {+ padding-top: 0.5rem;+ border-top: 1px dashed var(--widget-text-color);+ }+ .repo-card {+ .repo-name {+ margin: 0;+ font-weight: bold;+ }+ .repo-desc {+ margin: 0.2rem 0;+ font-size: 0.8rem;+ opacity: var(--dimming-factor);+ }+ .repo-stats {+ display: flex;+ flex-wrap: wrap;+ align-items: center;+ gap: 0.75rem;+ margin-top: 0.25rem;+ font-size: 0.85rem;+ .stat {+ display: inline-flex;+ align-items: center;+ gap: 0.25rem;+ font-family: var(--font-monospace);+ .icon {+ width: 0.9rem;+ height: 0.9rem;+ fill: currentColor;+ }+ }+ .lang {+ display: inline-flex;+ align-items: center;+ gap: 0.3rem;+ .dot {+ width: 0.7rem;+ height: 0.7rem;+ border-radius: 50%;+ }+ }+ }}-}+ // Underline the heading on hover, to signal the card is a link+ .profile-card:hover .name,+ .repo-card:hover .repo-name {+ text-decoration: underline;+ }+}</style>diff --git a/src/utils/config/defaults.js b/src/utils/config/defaults.jsindex 6429b9d1..efd63647 100644--- a/src/utils/config/defaults.js+++ b/src/utils/config/defaults.js@@ -223,6 +223,7 @@ const defaults = {ethGasHistory: 'https://www.ethgastracker.com/api/gas/history',exchangeRates: 'https://v6.exchangerate-api.com/v6/',flights: 'https://aerodatabox.p.rapidapi.com/flights/airports/icao/',+ githubApi: 'https://api.github.com',githubTrending: 'https://trend.doforce.xyz/',hackernewsTrending: 'https://hacker-news.firebaseio.com/v0',healthChecks: 'https://healthchecks.io/api/v1/checks',@@ -241,7 +242,6 @@ const defaults = {publicIp4: 'https://free.freeipapi.com/api/json',publicIp5: 'https://ipinfo.io/json',publicIp6: 'https://api.ipquery.io/?format=json',- readMeStats: 'https://github-readme-stats.vercel.app/api',rescueTime: 'https://www.rescuetime.com/anapi/data',rssToJson: 'https://api.rss2json.com/v1/api.json',sportsScores: 'https://www.thesportsdb.com/api/v1/json',