For a developer, a personal portfolio plays an important role to showcase his/her works, reach to potential clients or land a job. But making it requires a tremendous amount of works and time. Also maintaining it manually with the latest project is a pain.
What if you could create your portfolio in 5 minutes just by providing your Github username and even host it without any cost? Do you want to display your skills, job history, education history, or even dev.to posts to your website? Then you are in right place.
Introducing GitProfile to kickstart your personal portfolio with Github Api and blog.
arifszn / gitprofile
π Create and deploy a dynamic portfolio by just providing your GitHub username.
Easy to use automatic portfolio builder for every GitHub user!
View Demo Β· Report Bug Β· Request Feature
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
β 33 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.
π Installation & Setup
There are three ways to use GitProfile. Use any.
- β¦
GitProfile is an easy-to-customize personal dev portfolio template that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and repositories. Also, it includes space to highlight your details, job history, education history, skills, and recent blog posts.
It's all possible using GitHub API (for automatically populating your website with content) and Article-api (for fetching recent blog posts).
β 21 Themes
β Google Analytics
β Meta Tags
β Avatar and Bio
β Social Links
β Skills
β Experience
β Education
β Projects
β Blog Posts
To view a live example, click here.
π Installation & Set Up
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You'll need Git and Node.js (which comes with npm) installed on your computer.
Fork the repo so you have your own project to customize. A "fork" is a copy of a repository.
Once you've found a home for your forked repository, clone it.
Change into your new directory.
cd gitprofile
Install dependencies
npm install
Start the development server
npm start
π¨ Customization
All the magic happens in the file src/config
. Open it and modify it according to your preference.
These are the default values:
config.js
// config.js
module.exports = {
github: {
username: 'arifszn', // Your GitHub org/user name. (Required)
sortBy: 'stars', // stars | 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: ['my-project1', 'my-project2']
}
},
social: {
linkedin: '',
twitter: '',
facebook: '',
dribbble: '',
behance: '',
medium: '',
devto: '',
website: '',
email: ''
},
skills: [
'JavaScript',
'React.js',
],
experiences: [
{
company: 'Company name 1',
position: 'Software Engineer',
from: 'July 2019',
to: 'Present'
},
{
company: 'Company name 2',
position: 'Jr. Software Engineer',
from: 'January 2019',
to: ' June 2019'
}
],
education: [
{
institution: 'Institution name 1',
degree: 'Bachelor of Science',
from: '2015',
to: '2019'
},
{
institution: 'Institution name 2',
degree: 'Higher Secondary Certificate (HSC)',
from: '2012',
to: '2014',
}
],
blog: {
// Display blog posts from your medium or dev.to account. (Optional)
source: 'dev.to', // medium | dev.to
username: 'arifszn',
limit: 5 // How many posts to display. Max is 10.
},
googleAnalytics: {
// GA3 tracking id/GA4 tag id
id: '' // UA-XXXXXXXXX-X | G-XXXXXXXXXX
},
themeConfig: {
default: 'light',
// Hides the theme change switch
// Useful if you want to support a single color mode
disableSwitch: false,
// Should we use the prefers-color-scheme media-query,
// using user system preferences, instead of the hardcoded default
respectPrefersColorScheme: true,
// Available themes. To remove any theme, exclude from here.
themes: [
'light',
'dark',
'cupcake',
'bumblebee',
'emerald',
'corporate',
'synthwave',
'retro',
'cyberpunk',
'valentine',
'halloween',
'garden',
'forest',
'aqua',
'lofi',
'pastel',
'fantasy',
'wireframe',
'black',
'luxury',
'dracula'
]
}
}
Themes
There are 21 themes available that can be selected from the dropdown.
The default theme can be specified.
// config.js
module.exports = {
// ...
themeConfig: {
default: 'light',
// ...
}
}
Here are some screenshots of different themes.
Google Analytics
GitProfile supports both GA3 and GA4. If you do not want to use Google Analytics, keep the id
empty.
// config.js
module.exports = {
// ...
googleAnalytics: {
id: ''
},
}
Besides tracking visitors, GitProfile will track click events on projects and blog posts, and send them to Google Analytics.
Meta Tags
Meta tags will be auto-generated from configs dynamically. However, you can also manually add meta tags in public\index.html
Avatar and Bio
Your github avatar and bio will be displayed here.
Social Links
GitProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, and email.
// config.js
module.exports = {
// ...
social: {
linkedin: 'ariful-alam',
twitter: 'arif_swozon',
facebook: '',
dribbble: '',
behance: '',
medium: '',
devto: '',
website: 'https://arifszn.github.io',
email: ''
},
}
Skills
To showcase your skills provide them here.
// config.js
module.exports = {
// ...
skills: [
'JavaScript',
'React.js',
],
}
Empty array will hide the skills section.
Experience
Provide your job history in experiences
.
// config.js
module.exports = {
// ...
experiences: [
{
company: 'Company name 1',
position: 'Software Engineer',
from: 'July 2019',
to: 'Present'
},
{
company: 'Company name 2',
position: 'Jr. Software Engineer',
from: 'January 2019',
to: ' June 2019'
}
],
}
Empty array will hide the experience section.
Education
Provide your education history in education
.
// config.js
module.exports = {
// ...
education: [
{
institution: 'Institution name 1',
degree: 'Bachelor of Science',
from: '2015',
to: '2019'
},
{
institution: 'Institution name 2',
degree: 'Higher Secondary Certificate (HSC)',
from: '2012',
to: '2014',
}
],
}
Empty array will hide the education section.
Projects
Your public repo from github will be displayed here automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo.
// config.js
module.exports = {
// ...
github: {
username: 'arifszn',
sortBy: 'stars',
limit: 8,
exclude: {
forks: false,
projects: ['my-project1', 'my-project2']
}
},
}
Blog Posts
If you have medium or dev.to account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is 10).
// config.js
module.exports = {
// ...
blog: {
source: 'dev.to',
username: 'arifszn',
limit: 5
},
}
The posts are fetched by Article-api.
π Deploy
Once you are done with your setup and have completed all steps above, you need to put your website online! The fastest approach is to use GitHub Pages which is completely free.
1. Github Pages:
- Rename your forked repository to
username.github.io
, whereusername
is your GitHub username (or organization name). -
Open
package.json
, and changehomepage
's value tousername.github.io
.
// package.json { // ... "homepage": "username.github.io", }
Run
npm run deploy
.If you see
README.md
atusername.github.io
, be sure to change your GitHub Page's source togh-pages
branch. See how to.
Your personal portfolio will be live at username.github.io
. For more info, visit here.
2. Other: You can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this doc for a detailed deployment guide.
Repo: https://github.com/arifszn/gitprofile
Demo: https://arifszn.github.io/gitprofile
Check out my other works: https://github.com/arifszn
Top comments (2)
Nice work man. Can you recommend resources for learning how to use the GitHub API. Or how to use API's in general. Thanks. ππ½
To start, you can follow the official documentation.