Skip to content

Commit 29e609c

Browse files
committed
Personalized the template
1 parent 9f5db4d commit 29e609c

File tree

46 files changed

+1154
-838
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1154
-838
lines changed

.eslintrc.cjs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ module.exports = {
22
root: true,
33
env: { browser: true, es2020: true, node: true },
44
extends: [
5-
'eslint:recommended',
6-
'plugin:@typescript-eslint/recommended',
7-
'plugin:react-hooks/recommended',
8-
'plugin:prettier/recommended',
5+
"eslint:recommended",
6+
"plugin:@typescript-eslint/recommended",
7+
"plugin:react-hooks/recommended",
8+
"plugin:prettier/recommended"
99
],
10-
ignorePatterns: ['dist', '.eslintrc.cjs'],
11-
parser: '@typescript-eslint/parser',
12-
plugins: ['react-refresh'],
10+
ignorePatterns: ["dist", ".eslintrc.cjs"],
11+
parser: "@typescript-eslint/parser",
12+
plugins: ["react-refresh"],
1313
rules: {
14-
'react-refresh/only-export-components': [
15-
'warn',
16-
{ allowConstantExport: true },
17-
],
18-
},
14+
"react-refresh/only-export-components": [
15+
"warn",
16+
{ allowConstantExport: true }
17+
]
18+
}
1919
};

.github/workflows/deploy.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ jobs:
4242
run: npm ci
4343

4444
- name: Build with vite
45-
run: npm run build
45+
run: |
46+
echo "CLARITY_ID=${{ vars.CLARITY_ID }}" >> .env
47+
CLARITY_ID=${{ vars.CLARITY_ID }} npm run build
4648
4749
- name: Upload artifact
4850
uses: actions/upload-pages-artifact@v3

.github/workflows/test-deploy.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ jobs:
3434
run: npm run prettier
3535

3636
- name: Build
37-
run: npm run build
3837
env:
3938
CI: ''
39+
run: |
40+
echo "CLARITY_ID=${{ vars.CLARITY_ID }}" >> .env
41+
CLARITY_ID=${{ vars.CLARITY_ID }} npm run build

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sorkhpar.dev

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<p align="center">
44
<img src="https://user-images.githubusercontent.com/45073703/177566625-9b84e793-4559-4475-ba54-8d3d5f4123d4.png" width="35%">
55

6-
<h4 align="center">Easy to use automatic portfolio builder for every GitHub user!</h4>
6+
<h4 align="center">Easy to use automatic portfolio builder for every GitHub user!</h4>
77

88
<p align="center">
99
<a href="https://codeclimate.com/github/arifszn/gitprofile/maintainability"><img src="https://api.codeclimate.com/v1/badges/c60f42d7d0b61bd33e98/maintainability" /></a>
@@ -38,7 +38,10 @@
3838
<a href="#arifszn"><img src="https://github.com/arifszn/gitprofile/assets/45073703/4d2ccd45-e566-4743-bf61-cadc03ece54c" width="50%" alt="Shadow"/></a>
3939
</p>
4040

41-
**GitProfile** is a powerful portfolio builder that allows you to create a stunning and personalized portfolio site in minutes, even if you have no coding experience. Simply provide your GitHub username, and GitProfile will automatically generate a portfolio. Best of all, you can easily deploy your portfolio to GitHub Pages with just a few clicks, making it accessible to the world in no time.
41+
**GitProfile** is a powerful portfolio builder that allows you to create a stunning and personalized portfolio site in
42+
minutes, even if you have no coding experience. Simply provide your GitHub username, and GitProfile will automatically
43+
generate a portfolio. Best of all, you can easily deploy your portfolio to GitHub Pages with just a few clicks, making
44+
it accessible to the world in no time.
4245

4346
**Features:**
4447

@@ -75,19 +78,24 @@ There are three ways to use **GitProfile**. Use any.
7578

7679
These instructions will get you a copy of the project and deploy your portfolio online using GitHub Pages!
7780

78-
- **Fork repo:** Click [here](https://github.com/arifszn/gitprofile/fork) to fork the repo so you have your own project to customize. A "fork" is a copy of a repository.
81+
- **Fork repo:** Click [here](https://github.com/arifszn/gitprofile/fork) to fork the repo so you have your own project
82+
to customize. A "fork" is a copy of a repository.
7983
- **Rename repo:**
80-
- If you want to host your portfolio at `https://<USERNAME>.github.io`, rename your forked repository to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name).
81-
- If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO_NAME>` (e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO_NAME>` (e.g. `portfolio`) in GitHub.
84+
- If you want to host your portfolio at `https://<USERNAME>.github.io`, rename your forked repository
85+
to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name).
86+
- If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO_NAME>` (
87+
e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO_NAME>` (e.g. `portfolio`)
88+
in GitHub.
8289
- **Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
8390

8491
![Workflows](https://github.com/arifszn/gitprofile/assets/45073703/7e82f7d4-900c-4cb9-83f9-bcaa1ca2b910)
8592

8693
- **Base Value:** Open `gitprofile.config.ts`, and change `base`'s value.
8794

88-
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
95+
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
8996

90-
- If you are deploying to `https://<USERNAME>.github.io/<REPO_NAME>` (e.g. `https://<USERNAME>.github.io/portfolio`), then set `base` to `'/<REPO_NAME>/'` (e.g. `'/portfolio/'`).
97+
- If you are deploying to `https://<USERNAME>.github.io/<REPO_NAME>` (
98+
e.g. `https://<USERNAME>.github.io/portfolio`), then set `base` to `'/<REPO_NAME>/'` (e.g. `'/portfolio/'`).
9199

92100
```ts
93101
// gitprofile.config.ts
@@ -97,13 +105,20 @@ These instructions will get you a copy of the project and deploy your portfolio
97105
}
98106
```
99107

100-
- **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.
108+
- **Commit the changes:** Now commit to your **main** branch with your changes. Wait a few minutes so that the CI/CD
109+
pipeline can publish your website to GitHub Pages. You can check the progress in
110+
the [Actions](https://github.com/arifszn/gitprofile/actions) tab.
101111

102-
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 `gitprofile.config.ts` file. Also, check if **Source** is set to **GitHub Actions** in **Settings****Pages****Build and deployment**.
112+
Your portfolio website will be live shortly. Any time you commit a change to the **main** branch, the website will be
113+
automatically updated. If you face any issue viewing the website, double-check the `base` value in
114+
the `gitprofile.config.ts` file. Also, check if **Source** is set to **GitHub Actions** in **Settings****Pages** ➜ *
115+
*Build and deployment**.
103116

104-
If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings****Pages****Custom domain**.
117+
If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings****Pages** ➜ *
118+
*Custom domain**.
105119

106-
As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services.
120+
As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please
121+
refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services.
107122

108123
> [!NOTE]
109124
> If you are going to deploy using **Vercel**, remember to set the `base` as `/`.
@@ -141,7 +156,8 @@ As this is a Vite project, you can also host your website to Netlify, Vercel, He
141156

142157
- Finally, visit `http://localhost:5173/gitprofile/` from your browser.
143158

144-
> Alternatively, you can set up and run the project using Docker with **[Vail](https://github.com/arifszn/vail)**, a powerful tool for local development of JavaScript/TypeScript Apps.
159+
> Alternatively, you can set up and run the project using Docker with **[Vail](https://github.com/arifszn/vail)**, a
160+
> powerful tool for local development of JavaScript/TypeScript Apps.
145161
146162
## 🎨 Customization
147163

@@ -213,6 +229,7 @@ const CONFIG = {
213229
twitter: 'arif_szn',
214230
mastodon: 'arifszn@mastodon.social',
215231
researchGate: '',
232+
googleScholar: { name: '', user: '' },
216233
facebook: '',
217234
instagram: '',
218235
reddit: '',
@@ -467,7 +484,8 @@ Besides tracking visitors, it will track `click events` on projects and blog pos
467484

468485
### Hotjar
469486

470-
**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.
487+
**GitProfile** supports [hotjar](https://www.hotjar.com) to track visitor interaction and behavior. If you do not want
488+
to use Hotjar, keep the `id` empty.
471489

472490
```ts
473491
// gitprofile.config.ts
@@ -498,7 +516,8 @@ const CONFIG = {
498516

499517
### PWA
500518

501-
GitProfile is PWA enabled. The site can be installed as a Progressive Web App. To turn it off, set `enablePWA` to `false`.
519+
GitProfile is PWA enabled. The site can be installed as a Progressive Web App. To turn it off, set `enablePWA`
520+
to `false`.
502521

503522
![PWA](https://github.com/arifszn/gitprofile/assets/45073703/9dc7cc5c-4262-4445-a7a5-1e3566ef43fa)
504523

@@ -508,7 +527,9 @@ Your avatar and bio will be fetched from GitHub automatically.
508527

509528
### Social Links
510529

511-
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, ResearchGate, Facebook, Instagram, Reddit, Threads, YouTube, Udemy, Dribbble, Behance, Medium, dev, Stack Overflow, Skype, Telegram, personal website, phone and email.
530+
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, ResearchGate,
531+
GoogleScholar, Facebook, Instagram, Reddit, Threads, YouTube, Udemy, Dribbble, Behance, Medium, dev, Stack Overflow,
532+
Skype, Telegram, personal website, phone and email.
512533

513534
```ts
514535
// gitprofile.config.ts
@@ -725,7 +746,8 @@ Empty array will hide the publications section.
725746

726747
### Blog Posts
727748

728-
If you have [medium](https://medium.com) or [dev](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev username. You can limit how many posts to display (Max is `10`).
749+
If you have [medium](https://medium.com) or [dev](https://dev.to) account, you can show your recent blog posts in here
750+
just by providing your medium/dev username. You can limit how many posts to display (Max is `10`).
729751

730752
```ts
731753
// gitprofile.config.ts

0 commit comments

Comments
 (0)