7.7 KiB
ezProfile
A modern, responsive and customizable portfolio template for Developers!
ezProfile 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 ezprofile
- Install dependencies
npm install
- Start the development server
npm start
🎨 Customization
All the magic happens in 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 which can be selected from the dropdown.
Here are some screenshots of different themes.
Google Analytics
ezFolio 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, ezFolio will track click event 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
ezProfile supports linking 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 in skills.
// 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 repos.
// 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']
}
},
}
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).
The posts are fetched by Article-api.