profile

ezProfile

A modern, responsive and customizable portfolio builder for Developers!

https://arifszn.github.io/ezprofile

ezProfile is an easy-to-customize personal dev portfolio builder 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 public 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
✓ Hotjar
✓ 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 and deploy your website online!

Fork the repo so you have your own project to customize by clicking the fork icon on the top right side. A “fork” is a copy of a repository.
Rename your forked repository to username.github.io in github, where username is your GitHub username (or organization name).
Go to your repo’s Actions page and enable workflows.

Open package.json, and change homepage’s value to https://username.github.io.

// package.json
{
  // ...
  "homepage": "https://username.github.io",
}

Now commit to your main branch with your changes.
The CI/CD pipeline will publish your page at the gh-pages branch automatically.
Go to your repo’s Settings -> Pages -> Source and change the branch to gh-pages and click save.
Your personal portfolio will be live at username.github.io.
Any time you commit a change to the main branch, the website will be automatically updated.

You can skip the above steps and do a manual deployment by running npm run deploy. For more info, visit here.

If you see only README at username.github.io, be sure to change your GitHub Page’s source to gh-pages branch. See how to. Also, if you face any issue rendering the website, double-check the homepage value in the package.json. It must be the value matching the repository name.

As this is a create react app, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this doc for a detailed deployment guide to other services.

🎨 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: '', phone: '', 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 }, hotjar: { id: '', snippetVersion : 6 }, 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',
    // ...
  }
}

Theme Dropdown

Here are some screenshots of different themes.

Themes

Themes

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 events on projects and blog posts, and send them to Google Analytics.

Event

Hotjar

ezProfile supports hotjar. If you do not want to use Hotjar, keep the id empty.

// config.js
module.exports = {
  // ...
  hotjar: {
    id: '',
    snippetVersion : 6 
  },
}

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.

ezProfile supports linking your social media services you’re using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, phone and email.

// config.js
module.exports = {
  // ...
  social: {
    linkedin: 'ariful-alam',
    twitter: 'arif_swozon',
    facebook: '',
    dribbble: '',
    behance: '',
    medium: '',
    devto: '',
    website: 'https://arifszn.github.io',
    phone: '',
    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
  },
}

Blog

The posts are fetched by Article-api.

📢 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. However, You are open to use this project by forking it and change any code necessary by giving attribute to the original author. Please see this issue for more info.

💖 Support

💡 Contributing

Any contributors who want to make this project 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.

This site is open source. Improve this page.