- Use `npm run lint` and `npm run prettier` before committing
- Example for a commit message
1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/arifszn/gitprofile/issues) or [open a new one](https://github.com/arifszn/gitprofile/issues/new).
2. Once done, [fork the repository](https://github.com/arifszn/gitprofile/fork) in your own GitHub account.
3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
4. Make the changes on your branch.
5. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main repository. <br>
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**.
<img src="https://user-images.githubusercontent.com/45073703/189209364-fc4df315-b66a-4654-907d-b0b7a9d2161e.gif" alt="Thank You" width="60%"/>
</a>
</p>
## 🛠 Installation & Setup
There are three ways to use **GitProfile**. Use any.
- Forking this repo
- Forking this repo_(recommended)_
- Setting up locally
- Installing as package
@@ -112,7 +124,7 @@ These instructions will get you a copy of the project and deploy your portfolio
- **Commit the changes:** Now commit to your **main** branch with your changes. Wait a few minutes so that the CI/CD pipeline can publish your website to GitHub Pages. You can check the progress in the [Actions](https://github.com/arifszn/gitprofile/actions) tab.
Your portfolio website will be live shortly. Any time you commit a change to the **main** branch, the website will be automatically updated. If you face any issue viewing the website, double-check the `base` value in the `vite.config.js` file.
Your portfolio website will be live shortly. Any time you commit a change to the **main** branch, the website will be automatically updated. If you face any issue viewing the website, double-check the `base` value in the `vite.config.js` file. Also, check if **Source** is set to **GitHub Actions** in **Settings** ➜ **Pages** ➜ **Build and deployment**.
If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings** ➜ **Pages** ➜ **Custom domain**.
@@ -206,35 +218,41 @@ const config = {
behance: '',
medium: '',
dev: '',
stackoverflow: '',
website: '',
phone: '',
email: '',
},
resume: {
fileUrl: '', // Empty fileUrl will hide the `Download Resume` button.
},
skills: ['JavaScript', 'React.js'],
experiences: [
{
company: 'Company name 1',
position: 'Software Engineer',
from: 'July 2019',
company: 'Company Name',
position: 'Position',
from: 'September 2021',
to: 'Present',
companyLink: 'https://example.com',
},
{
company: 'Company name 2',
position: 'Jr. Software Engineer',
from: 'January 2019',
to: ' June 2019',
company: 'Company Name',
position: 'Position',
from: 'July 2019',
to: 'August 2021',
companyLink: 'https://example.com',
},
],
education: [
{
institution: 'Institution name 1',
degree: 'ABC',
institution: 'Institution Name',
degree: 'Degree',
from: '2015',
to: '2019',
},
{
institution: 'Institution name 2',
degree: 'XYZ',
institution: 'Institution Name',
degree: 'Degree',
from: '2012',
to: '2014',
},
@@ -246,9 +264,9 @@ const config = {
limit: 5, // How many posts to display. Max is 10.
},
googleAnalytics: {
// GA3 tracking id/GA4 tag id
id: '', // UA-XXXXXXXXX-X | G-XXXXXXXXXX
id: '', // GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
},
// Track visitor interaction and behavior. https://www.hotjar.com
**GitProfile** supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty.
@@ -379,7 +393,7 @@ Besides tracking visitors, it will track `click events` on projects and blog pos
### Hotjar
**GitProfile** supports hotjar. If you do not want to use Hotjar, keep the `id` empty.
**GitProfile** supports [hotjar](https://www.hotjar.com) to track visitor interaction and behavior. If you do not want to use Hotjar, keep the `id` empty.
```js
// gitprofile.config.js
@@ -402,7 +416,7 @@ Your avatar and bio will be fetched from GitHub automatically.
### Social Links
You can link your social media services you're using, including LinkedIn, Twitter, Facebook, Instagram, Dribbble, Behance, Medium, dev, personal website, phone and email.
You can link your social media services you're using, including LinkedIn, Twitter, Facebook, Instagram, Dribbble, Behance, Medium, dev, Stack Overflow, personal website, phone and email.
```js
// gitprofile.config.js
@@ -417,6 +431,7 @@ module.exports = {
behance: '',
medium: '',
dev: '',
stackoverflow: '',
website: '',
phone: '',
email: '',
@@ -448,16 +463,18 @@ module.exports = {
// ...
experiences: [
{
company: 'Company name 1',
position: 'Software Engineer',
from: 'July 2019',
company: 'Company Name',
position: 'Position',
from: 'September 2021',
to: 'Present',
companyLink: 'https://example.com',
},
{
company: 'Company name 2',
position: 'Jr. Software Engineer',
from: 'January 2019',
to: ' June 2019',
company: 'Company Name',
position: 'Position',
from: 'July 2019',
to: 'August 2021',
companyLink: 'https://example.com',
},
],
};
@@ -534,7 +551,7 @@ The posts are fetched by [blog.js](https://github.com/arifszn/blog.js).
## 💖 Support
<p>You can show your support by starring this project.</p>
<p>You can show your support by starring this project. ★</p>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
