[opensourcedex]

gitprofile is a free, open source blogging & personal sites project written in TypeScript and released under MIT. It has 2,307 GitHub stars, 2,162 forks and 7 open issues, and was last pushed 17 days ago. On this registry it ranks #16 of 25 tracked projects in Blogging & Personal Sites, with 5 head-to-head comparisons available.

What is gitprofile?

What it is

GitProfile is an open-source portfolio builder written in TypeScript and released under the MIT license. It generates a personal website from a GitHub username and publishes that site through GitHub Pages. The project is designed for people who want a public profile without building a website from scratch.

The concrete problem it solves is the repetitive work of maintaining a personal site. Instead of manually editing HTML, CSS, and deployment files, a user forks the repository, changes a configuration file, and lets GitHub Actions build and publish the site. The resulting page can include avatar, bio, social links, skills, experience, certifications, education, projects, publications, and blog posts.

Key capabilities

  • GitProfile creates a portfolio from a GitHub username and supports sections for avatar, bio, social links, skills, experience, certifications, education, projects, publications, and blog posts.
  • It provides 36 themes, allowing users to choose a visual style without writing custom CSS.
  • It supports Google Analytics and Hotjar integrations for visitor and interaction data.
  • It includes SEO features and can be used as a progressive web app through PWA support.
  • It deploys through GitHub Pages using Actions workflows, and it updates when changes are committed to the main branch.
  • It allows custom domains through GitHub Pages settings, and it can also be hosted on Netlify, Vercel, Heroku, or other Vite-compatible services.

Who uses it and how

  • Developers and students can use GitProfile as a GitHub-synced personal website for projects, skills, experience, and social links.
  • Academic users can use the publication and education sections to present research output alongside a GitHub profile.
  • Users who want a low-maintenance site can fork the repository, enable GitHub Actions, and publish the site to GitHub Pages.
  • Site owners who want analytics can configure Google Analytics and Hotjar in the project settings.
  • Users who need a custom domain can add the domain in GitHub Pages settings, while other hosting options include Netlify, Vercel, and Heroku.

Getting started

The recommended setup is to fork the repository, enable GitHub Actions, set the base value in gitprofile.config.ts, and commit to the main branch so GitHub Pages publishes the site. For local development, users need Node.js 20 or newer, install dependencies with npm, and run the development server with npm run dev; Docker setup with Vail is also mentioned.

When to use it — and when not to

GitProfile is useful when a user wants a GitHub-centric portfolio maintained through a fork, a configuration file, and GitHub Pages. It is less suitable for people who need a fully custom website, because the workflow depends on GitHub account data, repository settings, and CI/CD publishing. The README does not mention database, storage, or SMTP requirements, but local development requires Node.js 20 or newer, and incorrect base configuration can prevent the site from displaying correctly.

project readme (upstream, from github) — read inline

Your GitHub-synced portfolio — easy to set up, updates itself!

View Demo · Report Bug · Request Feature

Preview
Shadow

GitProfile is a powerful portfolio builder that allows you to create a stunning and personalized portfolio site in minutes, even if you have no coding experience. Simply provide your GitHub username, and GitProfile will automatically generate a portfolio. Best of all, you can easily deploy your portfolio to GitHub Pages with just a few clicks, making it accessible to the world in no time.

Features:

✓ Easy to Setup
✓ 36 Themes
✓ Google Analytics
✓ Hotjar
✓ SEO
✓ PWA
✓ Avatar and Bio
✓ Social Links
✓ Skill Section
✓ Experience Section
✓ Certification Section
✓ Education Section
✓ Projects Section
✓ Publication Section
✓ Blog Posts Section

To view a live example, click here.

Themes

🛠 Installation & Setup

There are three ways to use GitProfile. Use any.

Forking this repo

These instructions will get you a copy of the project and deploy your portfolio online using GitHub Pages!

  • Fork repo: Click here to fork the repo so you have your own project to customize. A "fork" is a copy of a repository.

  • Rename repo:

    • If you want to host your portfolio at https://.github.io, rename your forked repository to username.github.io in GitHub, where username is your GitHub username (or organization name).
    • If you want to host your portfolio at https://.github.io/ (e.g. https://.github.io/portfolio), rename your forked repository to `` (e.g. portfolio) in GitHub.

  • Enable workflows: Go to your repo's Actions tab and enable workflows.

    Workflows

  • Base Value: Open gitprofile.config.ts, and change base's value.

    • If you are deploying to https://.github.io, set base to '/'.

    • If you are deploying to https://.github.io/ (e.g. https://.github.io/portfolio), then set base to '//' (e.g. '/portfolio/').

    // gitprofile.config.ts
{
  base: '/',
  // ...
}

  • Commit the changes: Now commit to your main branch with your changes. Wait a few minutes so that the CI/CD pipeline can publish your website to GitHub Pages. You can check the progress in the Actions tab.

Your portfolio website will be live shortly. Any time you commit a change to the main branch, the website will be automatically updated. If you face any issue viewing the website, double-check the base value in the gitprofile.config.ts file. Also, check if Source is set to GitHub Actions in Settings ➜ Pages ➜ Build and deployment.

If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's Settings ➜ Pages ➜ Custom domain.

As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this doc for a detailed deployment guide to other services.

[!NOTE] If you are going to deploy using Vercel, remember to set the base as /.

// gitprofile.config.ts
{
  base: '/',
  // ...
}

Not working?

Setting up locally

Requires Node.js 20+.

  • Clone the project and change directory.

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

  • Install dependencies.

    npm install

  • Run dev server.

    npm run dev

  • Finally, visit http://localhost:5173/gitprofile/ from your browser.

Alternatively, you can set up and run the project using Docker with Vail, a powerful tool for local development of JavaScript/TypeScript Apps.

Letting an AI agent do it

If you use Claude Code, Codex, Cursor, Gemini CLI, or any other coding agent, it can fork the repo, fill in your details, and deploy it for you. Just tell your agent to install it — paste:

Fetch and follow the install instructions from
https://raw.githubusercontent.com/arifszn/gitprofile/refs/heads/main/INSTALL.md

The agent will ask you what to put on your portfolio, then handle the config and deployment. With the GitHub CLI authenticated it deploys to GitHub Pages; without it, it deploys to Surge, Vercel, or Netlify instead.

🎨 Customization

All the magic happens in the file gitprofile.config.ts. Open it and modify it according to your preference.

You can leave most of the sections empty if you don't want to display them on your portfolio.

// gitprofile.config.ts

const CONFIG = {
  github: {
    username: 'arifszn', // Your GitHub org/user name. (This is the only required config)
  },
  /**
   * If you are deploying to https://.github.io/, for example your repository is at https://github.com/arifszn/arifszn.github.io, set base to '/'.
   * If you are deploying to https://.github.io//,
   * for example your repository is at https://github.com/arifszn/portfolio, then set base to '/portfolio/'.
   */
  base: '/gitprofile/',
  projects: {
    github: {
      display: true, // Display GitHub projects?
      header: 'Github Projects',
      mode: 'automatic', // Mode can be: 'automatic' or 'manual'
      automatic: {
        sortBy: 'stars', // Sort projects by 'stars' or 'updated'
        limit: 8, // How many projects to display.
        exclude: {
          forks: false, // Forked projects will not be displayed if set to true.
          projects: [], // These projects will not be displayed. example: ['arifszn/my-project1', 'arifszn/my-project2']
        },
      },
      manual: {
        // Properties for manually specifying projects
        projects: ['arifszn/gitprofile', 'arifszn/pandora'], // List of repository names to display. example: ['arifszn/my-project1', 'arifszn/my-project2']
      },
    },
    external: {
      header: 'My Projects',
      // To hide the `External Projects` section, keep it empty.
      projects: [
        {
          title: 'Project Name',
          description:
            'Lorem ipsum dolor

readme truncated — read the full docs on github

Frequently asked questions

Is gitprofile free to use?

gitprofile is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does gitprofile do?

🚀 Create and publish a GitHub-synced portfolio by just providing your GitHub username.

What is gitprofile written in?

gitprofile is primarily written in TypeScript. Its source is publicly available at https://github.com/arifszn/gitprofile, and it has 2,307 GitHub stars.