A modern, responsive and customizable portfolio builder for Developers!
https://arifszn.github.io/ezprofile
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.
```js
// 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 automatically update.
You can skip the above steps and do a manual deployment by running npm run deploy. For more info, visit [here](https://create-react-app.dev/docs/deployment/#github-pages).
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](https://create-react-app.dev/docs/deployment) for a detailed deployment guide to other services.
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](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
## 🎨 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:
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.\
id empty.
```js
// 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.\
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).
## 📢 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/changing the footer notice. However You are open to use this project by forking it and change any code necessary(except footer notice). Go through the [License](https://github.com/arifszn/ezprofile/blob/main/LICENSE) before thinking of stealing this project. For every stolen copy found, an issue will be created on the concerned repo and a [DMCA Takedown](https://www.dmca.com/FAQ/What-is-a-DMCA-Takedown) notice will be sent. Do not fall into this [list](https://github.com/arifszn/ezprofile/issues/2).
## 💖 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 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](https://github.com/arifszn/ezprofile/blob/main/LICENSE).