Repolode
arifszn

arifszn/gitprofile

A TypeScript template that builds a GitHub-synced developer portfolio site from just your GitHub username, deployable to GitHub Pages.

Stars
2,326
Forks
2,156
Open issues
10
Last commit
2 months ago

What is it?

GitProfile generates a personal portfolio website from a GitHub username. Avatar, bio and repositories are pulled from GitHub automatically, so the site updates as your profile changes. Other sections such as skills, work experience, education, certifications, publications and external projects are filled in through a single gitprofile.config.ts file.

The project is built with Vite and offers 36 selectable daisyUI themes, custom theme support through CSS variables, SEO meta settings, optional Google Analytics (GA3 and GA4) and Hotjar tracking, and PWA installation. Blog posts can be shown from a Medium or dev.to account.

Setup is a fork-and-deploy flow using GitHub Actions and GitHub Pages, with alternatives for Vercel, Netlify and Surge. It can also run locally on Node.js 20+ with a dev server.

Key features

  • 01Builds a portfolio automatically from a GitHub username, with avatar and bio synced from GitHub.
  • 02Shows GitHub projects in automatic (by stars or last updated) or manual mode.
  • 03Provides 36 selectable themes and supports custom themes.
  • 04Includes sections for skills, experience, education, certifications, publications and blog posts.
  • 05Supports SEO meta tags, Google Analytics, Hotjar and PWA installation.
  • 06Deploys to GitHub Pages via GitHub Actions, or to Vercel, Netlify and Surge.

Use cases

  • Developers who want a quick online portfolio without writing front-end code.
  • Academics listing publications alongside their code projects.
  • Job seekers who need a resume-style site linked to their GitHub activity.

Quick start

  1. 1

    Clone the repository

    git clone https://github.com/arifszn/gitprofile.git
  2. 2

    Change into the project directory

    cd gitprofile
  3. 3

    Install dependencies

    npm install
  4. 4

    Start the dev server, then open http://localhost:5173/gitprofile/

    npm run dev

Things to know

  • Local setup requires Node.js 20 or newer.
  • Deploying to a project subpath on GitHub Pages requires manually setting the base value in gitprofile.config.ts.

In collections

Topics

FAQ

What is gitprofile?
A TypeScript template that builds a GitHub-synced developer portfolio site from just your GitHub username, deployable to GitHub Pages. GitProfile generates a personal portfolio website from a GitHub username. Avatar, bio and repositories are pulled from GitHub automatically, so the site updates as your profile changes. Other sections such as skills, work experience, education, certifications, publications and external projects are filled in through a single gitprofile.config.ts file.
Is gitprofile free to use? What license does it have?
gitprofile is open source under the MIT license. Check the license terms before using it in commercial products.
Is gitprofile still maintained?
Updated within 6 months. The last commit to gitprofile was on Sep 1, 2026.
What can I use gitprofile for?
Developers who want a quick online portfolio without writing front-end code. Academics listing publications alongside their code projects. Job seekers who need a resume-style site linked to their GitHub activity.
How do I install gitprofile?
Clone the repository: git clone https://github.com/arifszn/gitprofile.git Change into the project directory: cd gitprofile Install dependencies: npm install Start the dev server, then open http://localhost:5173/gitprofile/: npm run dev
Where can I get gitprofile?
The source code and installation instructions are on GitHub: https://github.com/arifszn/gitprofile

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects