Giter Club home page Giter Club logo

gitfolio-online's Introduction

Gitfolio-online

GitHub top language GitHub last commit GitHub code style: prettier visitors

中文 README

Introduction

Personal Website For Every Github User

Gitfolio will help you get started with a portfolio website where you could showcase your work.

Check out this live demo to see gitfolio in action.

Features

  • Easy display your github info
  • support multiple themes
  • Customizable

Getting Started

Copy paste this , and that's it. Simple!

Change the username to your GitHub's username.

https://gitfolio-online.vercel.app/user/{username}?theme={theme}&includeFork={includeFork}&cache_seconds={cache_seconds}
https://gitfolio-online.vercel.app/u/{username}?theme={theme}&includeFork={includeFork}&cache_seconds={cache_seconds}

Themes

Use ?theme=THEME_NAME parameter like so :-

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

Include Forks

Use ?includeFork=true/false parameter you can select whether to display fork repos

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

Params

You can customize the appearance of your page however you want with URL params.

Option type description default
username string set username 'wangningkai'
theme string sets inbuilt theme 'dark'
cache_seconds number manually set custom cache control 1800
includeFork bool select whether to display fork repos false

Deploy on your own Vercel instance

Since the GitHub API only allows 5k requests per hour, it is possible that my https://gitfolio-online.vercel.app/u/wangningkai could hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!

Deploy to Vercel

Bug report

Please read before bug report《How To Ask Questions The Smart Way》

3 way to bug report:

  1. GitHub issue
  2. Blog
  3. [email protected]

💖 Support the project

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.

However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-

  • Starring and sharing the project 🚀
  • paypal.me/wangningkai - You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵
  • Wechat & AliPay

Thanks! ❤️

License

GitHub


Contributions are welcomed! <3

Made with ❤️ and JavaScript.

gitfolio-online's People

Contributors

wangningkai avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.