Bump version to 2.1.0 🚀

Update dependencies

.github/workflows/deploy.yml

@@ -1,14 +1,22 @@
-name: Deploy to gh-pages Branch
+name: Deploy to GitHub Pages
 
 on:
   push:
     branches: [main]
 
+  workflow_dispatch:
+
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -18,9 +26,13 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
+          cache: 'npm'
 
-      - name: Cache dependencies
-        uses: actions/cache@v2
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Restore cache
+        uses: actions/cache@v3
         with:
           path: |
             **/node_modules
@@ -29,13 +41,21 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Build
+      - name: Build with vite
         run: npm run build
-        env:
-          CI: ''
 
-      - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
         with:
-          branch: gh-pages
-          folder: dist
+          path: ./dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/test-deploy.yml

@@ -15,9 +15,10 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
+          cache: 'npm'
 
-      - name: Cache dependencies
-        uses: actions/cache@v2
+      - name: Restore cache
+        uses: actions/cache@v3
         with:
           path: |
             **/node_modules

.npmignore

@@ -9,6 +9,6 @@ CONTRIBUTING.md
 gitprofile.config.js
 index.html
 library.config.js
-tailwind.config.js
+tailwind.config.mjs
 vite.config.js
 stats.html

.prettierrc

@@ -4,5 +4,6 @@
   "bracketSpacing": true,
   "printWidth": 80,
   "singleQuote": true,
-  "tabWidth": 2
+  "tabWidth": 2,
+  "endOfLine": "auto"
 }

CONTRIBUTING.md

@@ -14,31 +14,36 @@ with a fix.
 
 ## Submitting a Pull Request
 
-- If applicable, update the `readme`
-- 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**.
 
-  ```
-  Fix type validation for typescript
-  ```
+## Development Workflow
 
-### Developing
-
-Fork, then clone the repo:
-
-```sh
-git clone https://github.com/your-username/gitprofile.git
-cd gitprofile
-```
-
-Install dependencies:
+### Install dependencies
 
 ```sh
 npm install
 ```
 
-Run dev server:
+### Run dev server
 
 ```sh
 npm run dev
 ```
+
+### Linter
+
+Each PR should pass the linter to be accepted. To fix lint and prettier errors, run `npm run lint:fix` and `npm run prettier:fix`.
+
+### Commit Message
+
+As minimal requirements, your commit message should:
+
+- be capitalized
+- not finish by a dot or any other punctuation character (!,?)
+- start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
+  e.g.: "Fix the home page button" or "Add support for dark mode"

LICENSE

@@ -1,201 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+MIT License
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+Copyright (c) 2022 Ariful Alam
 
-   1. Definitions.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2022 Ariful Alam
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -9,12 +9,18 @@
     <a href="https://codeclimate.com/github/arifszn/gitprofile/maintainability">
       <img src="https://api.codeclimate.com/v1/badges/c60f42d7d0b61bd33e98/maintainability" />
     </a>
+    <a href="https://github.com/arifszn/gitprofile/actions/workflows/test-deploy.yml">
+      <img src="https://github.com/arifszn/gitprofile/actions/workflows/test-deploy.yml/badge.svg" />
+    </a>
     <a href="https://github.com/arifszn/gitprofile/issues">
       <img src="https://img.shields.io/github/issues/arifszn/gitprofile"/>
     </a>
     <a href="https://github.com/arifszn/gitprofile/stargazers">
       <img src="https://img.shields.io/github/stars/arifszn/gitprofile"/>
     </a>
+    <a href="https://github.com/arifszn/gitprofile/network/members">
+      <img src="https://img.shields.io/github/forks/arifszn/gitprofile"/>
+    </a>
     <a href="https://github.com/arifszn/gitprofile/blob/main/package-lock.json">
       <img src="https://img.shields.io/snyk/vulnerabilities/github/arifszn/gitprofile"/>
     </a>
@@ -27,8 +33,8 @@
     <a href="https://www.buymeacoffee.com/arifszn">
       <img src="https://img.shields.io/badge/sponsor-buy%20me%20a%20coffee-yellow?logo=buymeacoffee"/>
     </a>
-    <a href="https://twitter.com/arif_szn">
-      <img src="https://img.shields.io/twitter/follow/arif_szn?style=social"/>
+    <a href="https://twitter.com/intent/tweet?text=Check%20out%20the%20portfolio%20builder.%20Create%20an%20automatic%20portfolio%20based%20on%20GitHub%20profile.&url=https://github.com/arifszn/gitprofile&hashtags=javascript,opensource,js,webdev,developers">
+      <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Farifszn%2Fgitprofile"/>
     </a>
   </p>
 
@@ -49,7 +55,7 @@
   <a href="#arifszn"><img src="https://arifszn.github.io/assets/img/drop-shadow.png" width="50%" alt="Shadow"/></a>
 </p>
 
-**GitProfile** is an easy to use portfolio builder where you can create a portfolio page automatically by just providing your GitHub username. It is built using React.js on top of Vite.js. But it's not necessary to have knowledge on these to get you started. You can make your own copy with zero coding experience.
+**GitProfile** is an easy to use portfolio builder where you can create a portfolio page automatically by just providing your GitHub username. It is built using React.js on top of Vite. But it's not necessary to have knowledge on these to get you started. You can make your own copy with zero coding experience.
 
 **Features:**
 
@@ -60,21 +66,34 @@
 ✓ [SEO](#seo)  
 ✓ [Avatar and Bio](#avatar-and-bio)  
 ✓ [Social Links](#social-links)  
-✓ [Skills](#skills)  
-✓ [Experience](#experience)  
-✓ [Education](#education)  
-✓ [Projects](#projects)  
-✓ [Blog Posts](#blog-posts)
+✓ [Skill Section](#skills)  
+✓ [Experience Section](#experience)  
+✓ [Education Section](#education)  
+✓ [Projects Section](#projects)  
+✓ [Blog Posts Section](#blog-posts)
 
 To view a live example, **[click here](https://arifszn.github.io/gitprofile)**.
 
 Or try it **[online](https://stackblitz.com/edit/gitprofile)**.
 
+<p align="center">
+  <img src="https://arifszn.github.io/assets/img/hosted/gitprofile/themes.png" alt="Themes">
+</p>
+
+## 🎉 Thank you for the 400 ★
+
+<p>
+  <a href="https://arifszn.github.io/gitprofile">
+    <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 two ways to use **GitProfile**. Use either one.
+There are three ways to use **GitProfile**. Use any.
 
-- Forking this repo
+- Forking this repo _(recommended)_
+- Setting up locally
 - Installing as package
 
 ### Forking this repo
@@ -85,7 +104,7 @@ These instructions will get you a copy of the project and deploy your portfolio
 - **Rename repo:**
   - 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).
   - If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO>` (e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO>` (e.g. `portfolio`) in GitHub.
-- **Enable workflows:** Go to your repo's **Actions** page and enable workflows.
+- **Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
 
   ![Workflows](https://arifszn.github.io/assets/img/hosted/gitprofile/workflows.png)
 
@@ -103,14 +122,36 @@ These instructions will get you a copy of the project and deploy your portfolio
   }
   ```
 
-- **First Commit:** Now commit to your **main** branch with your changes. The CI/CD pipeline will publish your page at the `gh-pages` branch automatically.
-- **Change deploy branch:** Go to your repo's **Settings** ➜ **Pages** ➜ **Source** and change the branch to `gh-pages` and click **save**.
+- **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 by now. Any time you commit a change to the **main** branch, the website will be automatically updated.
+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 see only `README` at your website, 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)). Also, if you face any issue rendering the website, double-check the `base` value in the `vite.config.js`.
+If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings** ➜ **Pages** ➜ **Custom domain**.
 
-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.
+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.
+
+### Setting up locally
+
+- Clone the project and change directory.
+
+  ```shell
+  git clone https://github.com/arifszn/gitprofile.git
+  cd gitprofile
+  ```
+
+- Install dependencies.
+
+  ```shell
+  npm install
+  ```
+
+- Run dev server.
+
+  ```shell
+  npm run dev
+  ```
+
+- Finally, visit [`http://localhost:5173/gitprofile/`](http://localhost:5173/gitprofile/) from your browser.
 
 ### Installing as package
 
@@ -177,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',
     },
@@ -213,13 +260,13 @@ const config = {
   // Display blog posts from your medium or dev account. (Optional)
   blog: {
     source: 'dev', // medium | dev
-    username: 'arifszn',
+    username: 'arifszn', // to hide blog section, keep it empty
     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
   hotjar: {
     id: '',
     snippetVersion: 6,
@@ -235,6 +282,9 @@ const config = {
     // using user system preferences, instead of the hardcoded defaultTheme
     respectPrefersColorScheme: true,
 
+    // Hide the ring in Profile picture
+    hideAvatarRing: false,
+
     // Available themes. To remove any theme, exclude from here.
     themes: [
       'light',
@@ -325,10 +375,6 @@ module.exports = {
 };
 ```
 
-<p align="center">
-  <img src="https://arifszn.github.io/assets/img/hosted/gitprofile/themes.png" alt="Themes">
-</p>
-
 ### Google Analytics
 
 **GitProfile** supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty.
@@ -347,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
@@ -370,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
@@ -385,6 +431,7 @@ module.exports = {
     behance: '',
     medium: '',
     dev: '',
+    stackoverflow: '',
     website: '',
     phone: '',
     email: '',
@@ -416,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',
     },
   ],
 };
@@ -502,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>
 <a href="https://github.com/arifszn/gitprofile/stargazers">
   <img src="https://img.shields.io/github/stars/arifszn/gitprofile?style=social" alt="Github Star">
 </a>
@@ -513,4 +562,4 @@ To contribute, see the [Contributing guide](https://github.com/arifszn/gitprofil
 
 ## 📄 License
 
-[Apache-2.0 License](https://github.com/arifszn/gitprofile/blob/main/LICENSE)
+[MIT](https://github.com/arifszn/gitprofile/blob/main/LICENSE)

gitprofile.config.js

@@ -19,10 +19,14 @@ const config = {
     behance: '',
     medium: 'arifszn',
     dev: 'arifszn',
+    stackoverflow: '', // format: userid/username
     website: 'https://arifszn.github.io',
     phone: '',
     email: 'arifulalamszn@gmail.com',
   },
+  resume: {
+    fileUrl: 'resume.pdf', // Empty fileUrl will hide the `Download Resume` button.
+  },
   skills: [
     'PHP',
     'Laravel',
@@ -31,64 +35,60 @@ const config = {
     'Node.js',
     'Nest.js',
     'MySQL',
+    'PostgreSQL',
     'Git',
     'Docker',
     'PHPUnit',
     'CSS',
     'Antd',
     'Tailwind',
-    'Bootstrap',
   ],
   experiences: [
     {
-      company: 'Monstarlab Bangladesh',
-      position: 'Backend Engineer II',
+      company: 'Company Name',
+      position: 'Position',
       from: 'September 2021',
       to: 'Present',
+      companyLink: 'https://example.com',
     },
     {
-      company: 'My Offer 360 Degree',
-      position: 'Web Application Developer',
+      company: 'Company Name',
+      position: 'Position',
       from: 'July 2019',
       to: 'August 2021',
+      companyLink: 'https://example.com',
     },
   ],
   education: [
     {
-      institution: 'American International University-Bangladesh',
-      degree: 'Bachelor of Science',
+      institution: 'Institution Name',
+      degree: 'Degree',
       from: '2015',
       to: '2019',
     },
     {
-      institution: 'Cantonment College, Jessore',
-      degree: 'Higher Secondary Certificate (HSC)',
+      institution: 'Institution Name',
+      degree: 'Degree',
       from: '2012',
       to: '2014',
     },
-    {
-      institution: 'Chowgacha Shahadat Pilot High School',
-      degree: 'Secondary School Certificate (SSC)',
-      from: '2007',
-      to: '2012',
-    },
   ],
   // Display blog posts from your medium or dev account. (Optional)
   blog: {
     source: 'dev', // medium | dev
-    username: 'arifszn',
+    username: 'arifszn', // to hide blog section, keep it empty
     limit: 3, // How many posts to display. Max is 10.
   },
   googleAnalytics: {
-    // GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
-    id: 'G-WLLB5E14M6', // Please remove this and use your own tag id or keep it empty
+    id: '', // GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
   },
+  // Track visitor interaction and behavior. https://www.hotjar.com
   hotjar: {
-    id: '2617601', //  Please remove this and use your own id or keep it empty
+    id: '',
     snippetVersion: 6,
   },
   themeConfig: {
-    defaultTheme: 'corporate',
+    defaultTheme: 'business',
 
     // Hides the switch in the navbar
     // Useful if you want to support a single color mode
@@ -98,6 +98,9 @@ const config = {
     // using user system preferences, instead of the hardcoded defaultTheme
     respectPrefersColorScheme: false,
 
+    // Hide the ring in Profile picture
+    hideAvatarRing: false,
+
     // Available themes. To remove any theme, exclude from here.
     themes: [
       'light',

library.config.js

@@ -2,7 +2,7 @@ import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 import tailwind from 'tailwindcss';
 import autoprefixer from 'autoprefixer';
-import tailwindConfig from './tailwind.config.js';
+import tailwindConfig from './tailwind.config.mjs';
 import path from 'path';
 
 // https://vitejs.dev/config/

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@arifszn/gitprofile",
   "description": "Create an automatic portfolio based on GitHub profile",
-  "version": "2.0.8",
-  "license": "Apache-2.0",
+  "version": "2.1.0",
+  "license": "MIT",
   "author": "arifszn",
   "repository": {
     "type": "git",
@@ -34,8 +34,8 @@
     "build:library": "vite build --config library.config.js",
     "lint": "eslint --ext .js,.jsx .",
     "lint:fix": "eslint --ext .js,.jsx --fix .",
-    "prettier": "prettier --check './**/*.{js,jsx,ts,tsx,css,md,json}'",
-    "prettier:fix": "prettier --write './**/*.{js,jsx,ts,tsx,css,md,json}'"
+    "prettier": "prettier --check \"./**/*.{js,jsx,ts,tsx,css,md,json}\"",
+    "prettier:fix": "prettier --write \"./**/*.{js,jsx,ts,tsx,css,md,json}\""
   },
   "dependencies": {
     "react": "^18.2.0",
@@ -45,7 +45,7 @@
     "@arifszn/blog-js": "^2.0.0",
     "@vitejs/plugin-react": "^2.0.0",
     "autoprefixer": "^10.4.4",
-    "axios": "^0.27.2",
+    "axios": "^1.1.3",
     "daisyui": "^2.11.0",
     "date-fns": "^2.28.0",
     "eslint": "^8.11.0",
@@ -85,6 +85,10 @@
     "git",
     "react-portfolio",
     "github",
+    "github-page",
+    "github-pages",
+    "github-portfolio",
+    "vite-portfolio",
     "github-api"
   ]
 }

src/components/GitProfile.jsx

@@ -25,6 +25,8 @@ import PropTypes from 'prop-types';
 import '../assets/index.css';
 import { formatDistance } from 'date-fns';
 
+const bgColor = 'bg-base-300';
+
 const GitProfile = ({ config }) => {
   const [error, setError] = useState(
     typeof config === 'undefined' && !config ? noConfigError : null
@@ -64,9 +66,14 @@ const GitProfile = ({ config }) => {
         };
 
         setProfile(profileData);
+        return data;
       })
-      .then(() => {
+      .then((userData) => {
         let excludeRepo = ``;
+        if (userData.public_repos === 0) {
+          setRepo([]);
+          return;
+        }
 
         sanitizedConfig.github.exclude.projects.forEach((project) => {
           excludeRepo += `+-repo:${sanitizedConfig.github.username}/${project}`;
@@ -144,7 +151,7 @@ const GitProfile = ({ config }) => {
         ) : (
           sanitizedConfig && (
             <Fragment>
-              <div className="p-4 lg:p-10 min-h-full bg-base-200">
+              <div className={`p-4 lg:p-10 min-h-full ${bgColor}`}>
                 <div className="grid grid-cols-1 lg:grid-cols-3 gap-6 rounded-box">
                   <div className="col-span-1">
                     <div className="grid grid-cols-1 gap-6">
@@ -156,7 +163,12 @@ const GitProfile = ({ config }) => {
                           themeConfig={sanitizedConfig.themeConfig}
                         />
                       )}
-                      <AvatarCard profile={profile} loading={loading} />
+                      <AvatarCard
+                        profile={profile}
+                        loading={loading}
+                        avatarRing={!sanitizedConfig.themeConfig.hideAvatarRing}
+                        resume={sanitizedConfig.resume}
+                      />
                       <Details
                         profile={profile}
                         loading={loading}
@@ -194,13 +206,9 @@ const GitProfile = ({ config }) => {
                   </div>
                 </div>
               </div>
-
-              {/* The below attribution notice shall be
-              included in all copies or substantial portions of the Software. */}
-              {/* DO NOT REMOVE/MODIFY THE BELOW FOOTER. */}
-              {/* SEE 4(C) SECTION OF THE LICENSE FOR MORE DETAILS. */}
-              {/* https://github.com/arifszn/gitprofile/blob/main/LICENSE */}
-              <footer className="p-4 footer bg-base-200 text-base-content footer-center">
+              <footer
+                className={`p-4 footer ${bgColor} text-base-content footer-center`}
+              >
                 <div className="card compact bg-base-100 shadow">
                   <a
                     className="card-body"
@@ -250,6 +258,7 @@ GitProfile.propTypes = {
       behance: PropTypes.string,
       medium: PropTypes.string,
       dev: PropTypes.string,
+      stackoverflow: PropTypes.string,
       website: PropTypes.string,
       phone: PropTypes.string,
       email: PropTypes.string,
@@ -287,6 +296,7 @@ GitProfile.propTypes = {
       defaultTheme: PropTypes.string,
       disableSwitch: PropTypes.bool,
       respectPrefersColorScheme: PropTypes.bool,
+      hideAvatarRing: PropTypes.bool,
       themes: PropTypes.array,
       customTheme: PropTypes.shape({
         primary: PropTypes.string,

src/components/avatar-card/index.jsx

@@ -2,7 +2,7 @@ import PropTypes from 'prop-types';
 import { fallbackImage, skeleton } from '../../helpers/utils';
 import LazyImage from '../lazy-image';
 
-const AvatarCard = ({ profile, loading }) => {
+const AvatarCard = ({ profile, loading, avatarRing, resume }) => {
   return (
     <div className="card shadow-lg compact bg-base-100">
       <div className="grid place-items-center py-8">
@@ -18,7 +18,13 @@ const AvatarCard = ({ profile, loading }) => {
           </div>
         ) : (
           <div className="avatar opacity-90">
-            <div className="mb-8 rounded-full w-32 h-32 ring ring-primary ring-offset-base-100 ring-offset-2">
+            <div
+              className={`mb-8 rounded-full w-32 h-32 ${
+                avatarRing
+                  ? 'ring ring-primary ring-offset-base-100 ring-offset-2'
+                  : ''
+              }`}
+            >
               {
                 <LazyImage
                   src={profile.avatar ? profile.avatar : fallbackImage}
@@ -49,6 +55,22 @@ const AvatarCard = ({ profile, loading }) => {
               : profile.bio}
           </div>
         </div>
+        {resume?.fileUrl &&
+          (loading ? (
+            <div className="mt-6">
+              {skeleton({ width: 'w-40', height: 'h-8' })}
+            </div>
+          ) : (
+            <a
+              href={resume.fileUrl}
+              target="_blank"
+              className="btn btn-outline btn-sm text-xs mt-6 opacity-50"
+              download
+              rel="noreferrer"
+            >
+              Download Resume
+            </a>
+          ))}
       </div>
     </div>
   );
@@ -57,6 +79,10 @@ const AvatarCard = ({ profile, loading }) => {
 AvatarCard.propTypes = {
   profile: PropTypes.object,
   loading: PropTypes.bool.isRequired,
+  avatarRing: PropTypes.bool.isRequired,
+  resume: PropTypes.shape({
+    fileUrl: PropTypes.string,
+  }),
 };
 
 export default AvatarCard;

src/components/blog/index.jsx

@@ -181,10 +181,10 @@ const Blog = ({ loading, blog, googleAnalytics }) => {
           <div className="grid grid-cols-2 gap-6">
             <div className="col-span-2">
               <div
-                className={`card compact ${
+                className={`card compact bg-base-100 ${
                   loading || (articles && articles.length)
-                    ? 'bg-gradient-to-br to-base-200 from-base-100 shadow'
-                    : 'bg-base-100 shadow-lg'
+                    ? 'card compact shadow bg-opacity-40'
+                    : 'shadow-lg'
                 }`}
               >
                 <div className="card-body">

src/components/details/index.jsx

@@ -15,6 +15,7 @@ import {
   FaDev,
   FaFacebook,
   FaGlobe,
+  FaStackOverflow,
 } from 'react-icons/fa';
 import PropTypes from 'prop-types';
 import { skeleton } from '../../helpers/utils';
@@ -93,8 +94,8 @@ const Details = ({ profile, loading, social, github }) => {
                   title="Company:"
                   value={profile.company}
                   link={
-                    isCompanyMention(profile.company)
-                      ? companyLink(profile.company)
+                    isCompanyMention(profile.company.trim())
+                      ? companyLink(profile.company.trim())
                       : null
                   }
                 />
@@ -169,6 +170,14 @@ const Details = ({ profile, loading, social, github }) => {
                   link={`https://dev.to/${social.dev}`}
                 />
               )}
+              {social?.stackoverflow && (
+                <ListItem
+                  icon={<FaStackOverflow className="mr-2" />}
+                  title="Stack Overflow:"
+                  value={social.stackoverflow.split('/').slice(-1)}
+                  link={`https://stackoverflow.com/users/${social.stackoverflow}`}
+                />
+              )}
               {social?.website && (
                 <ListItem
                   icon={<FaGlobe className="mr-2" />}

src/components/experience/index.jsx

@@ -2,7 +2,7 @@ import { skeleton } from '../../helpers/utils';
 import { Fragment } from 'react';
 import PropTypes from 'prop-types';
 
-const ListItem = ({ time, position, company }) => (
+const ListItem = ({ time, position, company, companyLink }) => (
   <li className="mb-5 ml-4">
     <div
       className="absolute w-2 h-2 bg-base-300 rounded-full border border-base-300 mt-1.5"
@@ -10,7 +10,11 @@ const ListItem = ({ time, position, company }) => (
     ></div>
     <div className="my-0.5 text-xs">{time}</div>
     <h3 className="font-semibold">{position}</h3>
-    <div className="mb-4 font-normal">{company}</div>
+    <div className="mb-4 font-normal">
+      <a href={companyLink} target="_blank" rel="noreferrer">
+        {company}
+      </a>
+    </div>
   </li>
 );
 
@@ -37,7 +41,6 @@ const Experience = ({ experiences, loading }) => {
 
     return array;
   };
-
   return (
     <>
       {experiences?.length !== 0 && (
@@ -66,6 +69,9 @@ const Experience = ({ experiences, loading }) => {
                         time={`${experience.from} - ${experience.to}`}
                         position={experience.position}
                         company={experience.company}
+                        companyLink={
+                          experience.companyLink ? experience.companyLink : null
+                        }
                       />
                     ))}
                   </Fragment>
@@ -83,6 +89,7 @@ ListItem.propTypes = {
   time: PropTypes.node,
   position: PropTypes.node,
   company: PropTypes.node,
+  companyLink: PropTypes.string,
 };
 
 Experience.propTypes = {

src/components/head-tag-editor/index.jsx

@@ -22,7 +22,7 @@ const HeadTagEditor = ({ profile, theme, googleAnalytics, social }) => {
                 gtag('config', '${googleAnalytics.id}');`}
             </script>
           )}
-          <title>Portfolio of {profile.name}</title>
+          <title>Portfolio{profile.name && ` of ${profile.name}`}</title>
           <meta
             name="theme-color"
             content={isDarkishTheme(theme) ? '#000000' : '#ffffff'}
@@ -30,18 +30,27 @@ const HeadTagEditor = ({ profile, theme, googleAnalytics, social }) => {
 
           <meta name="description" content={profile.bio} />
 
-          <meta itemProp="name" content={`Portfolio of ${profile.name}`} />
+          <meta
+            itemProp="name"
+            content={`Portfolio${profile.name && ` of ${profile.name}`}`}
+          />
           <meta itemProp="description" content={profile.bio} />
           <meta itemProp="image" content={profile.avatar} />
 
           <meta property="og:url" content={social?.website || ''} />
           <meta property="og:type" content="website" />
-          <meta property="og:title" content={`Portfolio of ${profile.name}`} />
+          <meta
+            property="og:title"
+            content={`Portfolio${profile.name && ` of ${profile.name}`}`}
+          />
           <meta property="og:description" content={profile.bio} />
           <meta property="og:image" content={profile.avatar} />
 
           <meta name="twitter:card" content="summary_large_image" />
-          <meta name="twitter:title" content={`Portfolio of ${profile.name}`} />
+          <meta
+            name="twitter:title"
+            content={`Portfolio${profile.name && ` of ${profile.name}`}`}
+          />
           <meta name="twitter:description" content={profile.bio} />
           <meta name="twitter:image" content={profile.avatar} />
         </Helmet>

src/components/project/index.jsx

@@ -4,6 +4,10 @@ import PropTypes from 'prop-types';
 import { ga, languageColor, skeleton } from '../../helpers/utils';
 
 const Project = ({ repo, loading, github, googleAnalytics }) => {
+  if (!loading && Array.isArray(repo) && repo.length === 0) {
+    return <></>;
+  }
+
   const renderSkeleton = () => {
     let array = [];
     for (let index = 0; index < github.limit; index++) {
@@ -132,7 +136,7 @@ const Project = ({ repo, loading, github, googleAnalytics }) => {
       <div className="col-span-1 lg:col-span-2">
         <div className="grid grid-cols-2 gap-6">
           <div className="col-span-2">
-            <div className="card compact bg-gradient-to-br to-base-200 from-base-100 shadow">
+            <div className="card compact bg-base-100 shadow bg-opacity-40">
               <div className="card-body">
                 <div className="mx-3 flex items-center justify-between mb-2">
                   <h5 className="card-title">

src/helpers/utils.jsx

@@ -153,10 +153,14 @@ export const sanitizeConfig = (config) => {
       behance: config?.social?.behance,
       medium: config?.social?.medium,
       dev: config?.social?.dev,
+      stackoverflow: config?.social?.stackoverflow,
       website: config?.social?.website,
       phone: config?.social?.phone,
       email: config?.social?.email,
     },
+    resume: {
+      fileUrl: config?.resume?.fileUrl || '',
+    },
     skills: config?.skills || [],
     experiences: config?.experiences || [],
     education: config?.education || [],
@@ -177,6 +181,7 @@ export const sanitizeConfig = (config) => {
       disableSwitch: config?.themeConfig?.disableSwitch || false,
       respectPrefersColorScheme:
         config?.themeConfig?.respectPrefersColorScheme || false,
+      hideAvatarRing: config?.themeConfig?.hideAvatarRing || false,
       themes: themes,
       customTheme: customTheme,
     },
@@ -214,7 +219,8 @@ export const notFoundError = {
   title: 'The Github Username is Incorrect.',
   subTitle: (
     <p>
-      Please provide correct github username in <code>config</code>.
+      Please provide correct github username in{' '}
+      <code>gitprofile.config.js</code>.
     </p>
   ),
 };

types/index.d.ts

@@ -79,6 +79,11 @@ export interface Social {
    */
   dev?: string;
 
+  /**
+   * Stack Overflow
+   */
+  stackoverflow?: string;
+
   /**
    * Website
    */
@@ -186,6 +191,11 @@ export interface ThemeConfig {
    */
   respectPrefersColorScheme?: boolean;
 
+  /**
+   * Hide the ring in Profile picture
+   */
+  hideAvatarRing?: boolean;
+
   /**
    * Available themes
    */
@@ -202,6 +212,7 @@ export interface Experience {
   position?: string;
   from?: string;
   to?: string;
+  companyLink?: string;
 }
 
 export interface Education {
@@ -211,6 +222,10 @@ export interface Education {
   to?: string;
 }
 
+export interface Resume {
+  fileUrl?: string;
+}
+
 export interface Config {
   /**
    * GitHub Config
@@ -222,6 +237,11 @@ export interface Config {
    */
   social?: Social;
 
+  /**
+   * Resume
+   */
+  resume?: Resume;
+
   /**
    * Skill list
    */

vite.config.js

@@ -2,7 +2,7 @@ import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 import tailwind from 'tailwindcss';
 import autoprefixer from 'autoprefixer';
-import tailwindConfig from './tailwind.config.js';
+import tailwindConfig from './tailwind.config.mjs';
 
 // https://vitejs.dev/config/
 export default defineConfig({