Gitfolio Online

A personal portfolio website for every GitHub user

Quick Start • Features • Customization • Local Development • Deployment

中文文档

---

Introduction

Gitfolio is a zero-configuration personal portfolio website that automatically fetches and displays your GitHub profile and repositories. No coding required—just use it and showcase your work to the world in seconds.

Perfect for developers, open-source contributors, and anyone who wants a professional GitHub portfolio without the hassle.

---

Quick Start

Get your portfolio up and running in 30 seconds:

Simply change {username} to your GitHub username:

https://gitfolio-online.vercel.app/user/{username}
# Or use the short version
https://gitfolio-online.vercel.app/u/{username}

That's it! 🎉

---

Features

🎨 Multiple Themes

Switch between light and dark themes with a single URL parameter.

🔄 Real-time Updates

Automatically fetches your latest GitHub activity (with smart caching).

⚡ Blazing Fast

Built with Vercel Edge Network for lightning-fast global performance.

🛠️ Highly Customizable

Fine-tune every aspect of your portfolio with URL parameters.

🚀 Zero Setup

No configuration files, no build steps, no deployment needed—just use it.

📦 Repository Filtering

Choose which repositories to display (include/exclude forks, limit count).

---

Customization

Themes

Switch between built-in themes:

https://gitfolio-online.vercel.app/u/{username}?theme=dark
https://gitfolio-online.vercel.app/u/{username}?theme=light

Include/Exclude Forks

Control whether to display forked repositories:

https://gitfolio-online.vercel.app/u/{username}?includeFork=true
https://gitfolio-online.vercel.app/u/{username}?includeFork=false

All Parameters

Parameter	Type	Description	Default	Example
username	string	Your GitHub username	-	wangningkai
theme	string	Built-in theme name	dark	dark, light
includeFork	boolean	Display forked repositories	false	true, false
repoNum	number	Number of repositories to display	30	10, 20, 50
cache_seconds	number	Cache duration in seconds	1800	600, 3600

Example Combinations

Combine multiple parameters:

https://gitfolio-online.vercel.app/u/wangningkai?theme=light&includeFork=true&repoNum=50

---

Live Demo

Check out these live examples:

• wangningkai - Full portfolio with forks
• torvalds - Linux creator's profile
• gaearon - React core team member

---

Local Development

Want to run Gitfolio locally? Follow these steps:

Prerequisites

• Node.js 12+
• GitHub Personal Access Token (optional, but recommended for higher API limits)

Installation

# Clone the repository
git clone https://github.com/wangningkai/gitfolio-online.git
cd gitfolio-online

# Install dependencies
npm install

Configuration

Create a .env file:

# GitHub Personal Access Token (optional)
GITHUB_TOKEN=your_github_token_here

# Custom cache duration (seconds, optional)
CACHE_SECONDS=1800

Running Locally

# Start the development server
npm run dev

# Or start with specific port
PORT=3000 npm run dev

Visit http://localhost:3000/u/{username} to see your portfolio.

Build for Production

# Build the project
npm run build

# Start production server
npm start

---

Deployment

Deploy to Vercel (Recommended)

Click the button below to deploy to your own Vercel instance:

Why deploy your own instance?

• Avoid rate limits: GitHub API has a 5,000 requests/hour limit
• Custom configuration: Full control over caching and themes
• Privacy: Your own instance with your own analytics
• Branding: Add your own domain and customization

Deploy to Other Platforms

Gitfolio works on any Node.js hosting platform:

• Netlify: Connect your Git repository
• Heroku: Use Heroku Buildpack for Node.js
• Railway: One-click deploy from GitHub
• Render: Deploy as a Node.js service
• Self-hosted: Run on any VPS or server

---

FAQ

Why do I need my own instance?

The GitHub API has rate limits (5,000 requests/hour). If many users share the same instance, you might encounter rate limit errors during peak hours. Deploying your own instance ensures consistent performance.

Can I use my own custom theme?

Currently, Gitfolio supports built-in light/dark themes. Custom theme support is planned for future releases.

How do I update my portfolio?

Gitfolio automatically fetches your latest GitHub data. Changes may take up to 30 minutes to appear (configurable with cache_seconds parameter).

Is there a limit on repositories?

Yes, by default Gitfolio displays up to 30 repositories. You can adjust this with the repoNum parameter (max 100 to ensure performance).

Can I hide specific repositories?

Currently, you can only show/hide all forks. Selective repository hiding is planned for future releases.

---

Contributing

Contributions are welcome! Here's how you can help:

Reporting Bugs

Before reporting bugs, please read How To Ask Questions The Smart Way.

Report bugs via:

• GitHub Issues (preferred)
• Email: i@ningkai.wang

Submitting Pull Requests

1. Fork the repository
2. Create a feature branch: git checkout -b my-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-feature
5. Submit a pull request

Development Guidelines

• Follow Prettier code style
• Write clear commit messages
• Test thoroughly before submitting

---

Support the Project

I open-source almost everything I can, and I try to help everyone using these projects. This takes time, and the service is provided for free.

If you find Gitfolio useful and want to support its development:

👏 Star and Share

• Star the repo on GitHub: ⭐
• Share it with your friends and colleagues: 🚀

💸 Donate

• PayPal: paypal.me/wangningkai
• WeChat & AliPay: pay.ningkai.wang

Your support helps me continue creating and maintaining open-source projects! ❤️

---

License

GPL-3.0 License - see LICENSE for details.

---

Acknowledgments

• Inspired by the original Gitfolio project
• Built with Vercel
• Powered by GitHub REST API

---

Made with ❤️ and JavaScript by @wangningkai and the open-source community.