ezProfile
A modern, responsive and customizable portfolio template for Developers!
https://arifszn.github.io/ezprofile
**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](https://developer.github.com/v3/) (for automatically populating your website with content) and [Article-api](https://github.com/arifszn/article-api) (for fetching recent blog posts).
✓ [21 Themes](#themes)\
✓ [Google Analytics](#google-analytics)\
✓ [Meta Tags](#meta-tags)\
✓ [Avatar and Bio](#avatar-and-bio)\
✓ [Social Links](#social-links)\
✓ [Skills](#skills)\
✓ [Experience](#experience)\
✓ [Education](#education)\
✓ [Projects](#projects)\
✓ [Blog Posts](#blog-posts)
To view a live example, **[click here](https://arifszn.github.io/ezprofile)**.
## 🛠 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](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer.
1. **[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)** the repo so you have your own project to customize. A "fork" is a copy of a repository.
2. Once you've found a home for your forked repository, **[clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)** it.
3. Change into your new directory.
```sh
cd ezprofile
```
4. Install dependencies
```sh
npm install
```
5. Start the development server
```sh
npm start
```
## 🎨 Customization
All the magic happens in the file src/config.js. Open it and modify it according to your preference.
These are the default values:
config.js
```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.
```js
// config.js
module.exports = {
// ...
themeConfig: {
default: 'light',
// ...
}
}
```
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.
```js
// config.js
module.exports = {
// ...
googleAnalytics: {
id: ''
},
}
```
Besides tracking visitors, ezFolio 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
ezProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, and email.
```js
// 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.
```js
// config.js
module.exports = {
// ...
skills: [
'JavaScript',
'React.js',
],
}
```
Empty array will hide the skills section.
### Experience
Provide your job history in experiences.
```js
// 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.
```js
// 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.
```js
// 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](https://medium.com) or [dev.to](https://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).
```js
// config.js
module.exports = {
// ...
blog: {
source: 'dev.to',
username: 'arifszn',
limit: 5
},
}
```
The posts are fetched by [Article-api](https://github.com/arifszn/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](https://pages.github.com) which is completely free.
**1. Github Pages:**
- Rename your forked repository to username.github.io in github, where username is your GitHub username (or organization name).
- Open package.json, and change homepage's value to https://username.github.io.
```js
// package.json
{
// ...
"homepage": "https://username.github.io",
}
```
- Run npm run deploy.
Your personal portfolio will be live at https://username.github.io. For more info, visit [here](https://create-react-app.dev/docs/deployment/#github-pages).
**2. Other:** You can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://create-react-app.dev/docs/deployment) for a detailed deployment guide.
## 📢 Please Read
I intend to keep my works open source. Please do not discourage me by claiming this work by copying it as your own or removing the footer notice.
## 💖 Support
If you are using this project and happy with it or just want to encourage me to continue creating stuff, you can do it by just starring and sharing the project.
## 💡 Contributing
Any contributors who want to make this website better can make contributions, which will be greatly appreciated. To contribute, clone this repo locally and commit your code to a new branch. Feel free to create an issue or make a pull request.
## 📄 License
ezProfile is licensed under the [Apache-2.0 License](https://github.com/arifszn/ezprofile/blob/main/LICENSE).