Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangningkai/gitfolio-online
:octocat: An online personal website for every Github user.
https://github.com/wangningkai/gitfolio-online
gitfilio github github-profile github-profile-info
Last synced: 3 months ago
JSON representation
:octocat: An online personal website for every Github user.
- Host: GitHub
- URL: https://github.com/wangningkai/gitfolio-online
- Owner: WangNingkai
- License: gpl-3.0
- Created: 2020-07-24T06:53:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-21T03:20:49.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T11:11:10.281Z (3 months ago)
- Topics: gitfilio, github, github-profile, github-profile-info
- Language: JavaScript
- Homepage: https://gitfolio-online.vercel.app
- Size: 325 KB
- Stars: 53
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitfolio-online
[](https://github.com/prettier/prettier)
> **[中文 README](./README_CN.md)**
## 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](https://gitfolio-online.vercel.app/user/wangningkai) 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 |
| repoNum | number | display repos number | 30 |
## 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!
[](https://vercel.com/import/project?template=https://github.com/wangningkai/gitfolio-online)
## Bug report
> Please read before bug report[《How To Ask Questions The Smart Way》](http://www.catb.org/~esr/faqs/smart-questions.html)
3 way to bug report：
1. [GitHub issue](https://github.com/WangNingkai/gitfolio-online/issues)
2. [Blog](https://imwnk.cn)
3. [[email protected]](mailto:[email protected])
### :sparkling_heart: 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 :rocket:
- [](https://www.paypal.me/wangningkai) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [Wechat & AliPay](https://pay.ningkai.wang)
Thanks! :heart:
## License
---
Contributions are welcomed! <3
Made with ❤️ and JavaScript.