Forkfolio will help you get started with a portfolio website where you could showcase your work + a blog that will help you spread your ideas into real world.
Check out this live demo to see forkfolio in action.
Install forkfolio
➜ ~ git clone https://github.com/k4ustu3h/forkfolio.git
➜ ~ cd forkfolio
➜ ~ npm install -gUsing the UI
➜ ~ forkfolio uiTip: You can use ui for updating your portfolio too.
or
➜ ~ forkfolio build <username><username> is your username on github. This will build your website using your GitHub username and put it in the /dist folder.
To run your website use run command, Default port is 3000
➜ ~ forkfolio run -p [port]🎉 Congrats, you just made yourself a personal website!
To include forks on your personal website just provide -f or --fork argument while building
➜ ~ forkfolio build <username> -fTo sort repos provide --sort [sortBy] argument while building. Where [sortBy] can be star, created, updated, pushed,full_name. Default: created
➜ ~ forkfolio build <username> --sort starTo order the sorted repos provide --order [orderBy] argument while building. Where [orderBy] can be asc or desc. Default: asc
➜ ~ forkfolio build <username> --sort star --order descThemes are specified using the --theme [theme-name] flag when running the build command. The available themes are
lightdark
TODO: Add more themes
For example, the following command will build the website with the dark theme
➜ ~ forkfolio build <username> --theme darkTo customize the background image just provide --background [url] argument while building.
➜ ~ forkfolio build <username> --background https://images.unsplash.com/photo-1557277770-baf0ca74f908?w=1634You could also add in your custom CSS inside index.css to give it a more personal feel.
You can either use your GitHub profile picture or you can add your initials in an animated gradient. Just provide -i or --initials argument while building.
Note that the limit of the characters you can enter in your initials is 3. If the characters exceed the limit only the first 3 will be shown.
➜ ~ forkfolio build <username> --initials K_You can also customize the gradient that your initials by specifying your preferred colors in (xdeg,#color1,#color2,...) format using -g or --gradient argument.
➜ ~ forkfolio build <username> --gradient 90deg,#2962ff,#aa00ff,#d50000forkfolio supports adding the following Social links
- Codepen
-c, --codepen <username> - Dev.to
-d, --dev <username> - Discord
-C, --discord <username#tag> - Dribbble
-D, --dribbble <username> - Email
-e, --email <email> - Facebook
-F, --facebook <username> - Instagram
-I, --instagram <username> - Keybase
-k, --keybase <username> - Medium
-m, --medium <username> - PayPal
-P, --paypal <username> - Pinterest
-n, --pinterest <username> - Reddit
-r, --reddit <username> - Snapchat
-S, --snapchat <username> - Stack Exchange
-E, --stackexchange <user id> - Steam
-a, --steam <username> - Telegram
-T, --telegram <username> - TV Time
-V, --tvtime <user id> - Tumblr
-u, --tumblr <username> - Twitch
-w, --twitch <username> - X
-X, --x <username> - XDA Developers
-x, --xda <user id> - YouTube
-y, --youtube <channel id>
➜ ~ forkfolio build <username> --discord k4ustu3h#5045 --reddit kaustubhladiya --x k4ustu3hHead over to GitHub and create a new repository named username.github.io, where username is your username. Push the files inside/dist folder to repo you just created.
Go To username.github.io your site should be up!!
To update your info, simply run
➜ ~ forkfolio updateor use the Update options in forkfolio's UI
This will update your info and your repository info.
To Update background or theme you need to run build command again.
- Hat tip to anyone who's code was used
- The original gitfolio made by @imfunniee
