diff --git a/README.md b/README.md
index 2a201e3..60af29a 100644
--- a/README.md
+++ b/README.md
@@ -30,9 +30,6 @@
-
- 
-
@@ -49,18 +46,18 @@
- 
+ 
- 
+ 
-**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.
+**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.
**Features:**
✓ [Easy to Setup](#-installation--setup)
-✓ [30 Themes](#themes)
+✓ [33 Themes](#themes)
✓ [Google Analytics](#google-analytics)
✓ [Hotjar](#hotjar)
✓ [SEO](#seo)
@@ -76,18 +73,8 @@
To view a live example, **[click here](https://arifszn.github.io/gitprofile)**.
-Or try it **[online](https://stackblitz.com/edit/gitprofile)**.
-
- 
-
-
-## 🎉 Thank you for the 800 ★
-
-
-
- 
-
+ 
## 🛠 Installation & Setup
@@ -96,7 +83,6 @@ There are three ways to use **GitProfile**. Use any.
- [Forking this repo _(recommended)_](#forking-this-repo)
- [Setting up locally](#setting-up-locally)
-- [Installing as package](#installing-as-package)
### Forking this repo
@@ -108,16 +94,16 @@ These instructions will get you a copy of the project and deploy your portfolio
- If you want to host your portfolio at `https://.github.io/` (e.g. `https://.github.io/portfolio`), rename your forked repository to `` (e.g. `portfolio`) in GitHub.
- **Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
- 
+ 
-- **Base Value:** Open `vite.config.js`, and change `base`'s value.
+- **Base Value:** Open `gitprofile.config.ts`, and change `base`'s value.
- If you are deploying to `https://.github.io`, set `base` to `'/'`.
- If you are deploying to `https://.github.io/` (e.g. `https://.github.io/portfolio`), then set `base` to `'//'` (e.g. `'/portfolio/'`).
- ```js
- // vite.config.js
+ ```ts
+ // gitprofile.config.ts
{
base: '/',
// ...
@@ -126,11 +112,11 @@ 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. Also, check if **Source** is set to **GitHub Actions** in **Settings** ➜ **Pages** ➜ **Build and deployment**.
+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**.
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. Also, if you are not deploying to GitHub pages, `base:` might need to be deleted from `vite.config.js`.
+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
@@ -155,86 +141,107 @@ As this is a Vite project, you can also host your website to Netlify, Vercel, He
- Finally, visit [`http://localhost:5173/gitprofile/`](http://localhost:5173/gitprofile/) from your browser.
-### Installing as package
-
-You can also use **GitProfile** by installing as an NPM package.
-
-First Install **GitProfile** via NPM.
-
-```sh
-npm install @arifszn/gitprofile
-```
-
-Or via Yarn.
-
-```sh
-yarn add @arifszn/gitprofile
-```
-
-Then, import the package, import and style and provide the config.
-
-```js
-import GitProfile from '@arifszn/gitprofile';
-import '@arifszn/gitprofile/dist/style.css';
-
-function App() {
- return (
-
- );
-}
-
-export default App;
-```
-
-List of all config [here](#-customization).
-
-**If you face any problems or have any questions, open an issue [here](https://github.com/arifszn/gitprofile/issues).**
-
## 🎨 Customization
-All the magic happens in the file `gitprofile.config.js`. Open it and modify it according to your preference.
+All the magic happens in the file `gitprofile.config.ts`. Open it and modify it according to your preference.
-```js
-// gitprofile.config.js
+```ts
+// gitprofile.config.ts
-const config = {
+const CONFIG = {
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']
+ username: 'arifszn', // Your GitHub org/user name. (This is the only required config)
+ },
+ /**
+ * If you are deploying to https://.github.io/, for example your repository is at https://github.com/arifszn/arifszn.github.io, set base to '/'.
+ * If you are deploying to https://.github.io//,
+ * for example your repository is at https://github.com/arifszn/portfolio, then set base to '/portfolio/'.
+ */
+ base: '/gitprofile/',
+ projects: {
+ github: {
+ display: true, // Display GitHub projects?
+ header: 'Github Projects',
+ mode: 'automatic', // Mode can be: 'automatic' or 'manual'
+ automatic: {
+ sortBy: 'stars', // Sort projects by 'stars' or '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: ['arifszn/my-project1', 'arifszn/my-project2']
+ },
+ },
+ manual: {
+ // Properties for manually specifying projects
+ projects: ['arifszn/gitprofile', 'arifszn/pandora'], // List of repository names to display. example: ['arifszn/my-project1', 'arifszn/my-project2']
+ },
+ },
+ external: {
+ header: 'My Projects',
+ // To hide the `External Projects` section, keep it empty.
+ projects: [
+ {
+ title: 'Project Name',
+ description:
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
+ imageUrl:
+ 'https://img.freepik.com/free-vector/illustration-gallery-icon_53876-27002.jpg',
+ link: 'https://example.com',
+ },
+ {
+ title: 'Project Name',
+ description:
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
+ imageUrl:
+ 'https://img.freepik.com/free-vector/illustration-gallery-icon_53876-27002.jpg',
+ link: 'https://example.com',
+ },
+ ],
},
},
+ seo: {
+ title: 'Portfolio of Ariful Alam',
+ description: '',
+ imageURL: '',
+ },
social: {
- linkedin: '',
- twitter: '',
- mastodon: '',
+ linkedin: 'ariful-alam',
+ twitter: 'arif_szn',
+ mastodon: 'arifszn@mastodon.social',
facebook: '',
instagram: '',
- youtube: '',
+ youtube: '', // example: 'pewdiepie'
dribbble: '',
behance: '',
- medium: '',
- dev: '',
- stackoverflow: '', // format: userid/username
- website: '',
+ medium: 'arifszn',
+ dev: 'arifszn',
+ stackoverflow: '', // example: '1/jeff-atwood'
skype: '',
telegram: '',
+ website: 'https://www.arifszn.com',
phone: '',
- email: '',
+ email: 'arifulalamszn@gmail.com',
},
resume: {
- fileUrl: '', // Empty fileUrl will hide the `Download Resume` button.
+ fileUrl:
+ 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', // Empty fileUrl will hide the `Download Resume` button.
},
- skills: ['JavaScript', 'React.js'],
+ skills: [
+ 'PHP',
+ 'Laravel',
+ 'JavaScript',
+ 'React.js',
+ 'Node.js',
+ 'Nest.js',
+ 'MySQL',
+ 'PostgreSQL',
+ 'Git',
+ 'Docker',
+ 'PHPUnit',
+ 'CSS',
+ 'Antd',
+ 'Tailwind',
+ ],
experiences: [
{
company: 'Company Name',
@@ -253,13 +260,13 @@ const config = {
],
certifications: [
{
- body: 'Certification Body Name',
- name: 'Sample Certification',
+ name: 'Lorem ipsum',
+ body: 'Lorem ipsum dolor sit amet',
year: 'March 2022',
link: 'https://example.com',
},
],
- education: [
+ educations: [
{
institution: 'Institution Name',
degree: 'Degree',
@@ -273,28 +280,11 @@ const config = {
to: '2014',
},
],
- // To hide the `My Projects` section, keep it empty.
- externalProjects: [
- {
- title: 'Project Name',
- description:
- 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
- imageUrl: 'https://via.placeholder.com/250x250',
- link: 'https://example.com',
- },
- {
- title: 'Project Name',
- description:
- 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
- imageUrl: 'https://via.placeholder.com/250x250',
- link: 'https://example.com',
- },
- ],
- // Display blog posts from your medium or dev account. (Optional)
+ // Display articles from your medium or dev account. (Optional)
blog: {
source: 'dev', // medium | dev
username: 'arifszn', // to hide blog section, keep it empty
- limit: 5, // How many posts to display. Max is 10.
+ limit: 3, // How many articles to display. Max is 10.
},
googleAnalytics: {
id: '', // GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
@@ -305,18 +295,18 @@ const config = {
snippetVersion: 6,
},
themeConfig: {
- defaultTheme: 'light',
+ defaultTheme: 'nord',
- // Hides the theme change switch
+ // Hides the switch in the navbar
// Useful if you want to support a single color mode
disableSwitch: false,
// Should use the prefers-color-scheme media-query,
// using user system preferences, instead of the hardcoded defaultTheme
- respectPrefersColorScheme: true,
+ respectPrefersColorScheme: false,
- // Hide the ring in Profile picture
- hideAvatarRing: false,
+ // Display the ring in Profile picture
+ displayAvatarRing: true,
// Available themes. To remove any theme, exclude from here.
themes: [
@@ -349,10 +339,13 @@ const config = {
'night',
'coffee',
'winter',
+ 'dim',
+ 'nord',
+ 'sunset',
'procyon',
],
- // Custom theme
+ // Custom theme, applied to `procyon` theme
customTheme: {
primary: '#fc055b',
secondary: '#219aaf',
@@ -365,19 +358,27 @@ const config = {
},
// Optional Footer. Supports plain text or HTML.
- footer: `Copyright © 2023 John Doe`,
+ footer: `Made with GitProfile and ❤️`,
+
+ enablePWA: true,
};
+
+export default CONFIG;
```
### Themes
-There are 30 themes available that can be selected from the dropdown.
+There are 33 themes available that can be selected from the dropdown.
The default theme can be specified.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
themeConfig: {
defaultTheme: 'light',
@@ -387,14 +388,14 @@ const config = {
```
- 
+ 
You can create your own custom theme by modifying these values. Theme `procyon` will have the custom styles.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
themeConfig: {
customTheme: {
@@ -415,9 +416,9 @@ const config = {
**GitProfile** supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
googleAnalytics: {
id: '',
@@ -431,9 +432,9 @@ Besides tracking visitors, it will track `click events` on projects and blog pos
**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
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
hotjar: {
id: '',
@@ -444,11 +445,23 @@ const config = {
### SEO
-Meta tags will be auto-generated from configs dynamically. However, you can also manually add meta tags in `public/index.html`.
+You can customize the meta tags for SEO in `seo`.
+
+```ts
+// gitprofile.config.ts
+const CONFIG = {
+ // ...
+ seo: {
+ title: 'Portfolio of Ariful Alam',
+ description: '',
+ imageURL: '',
+ },
+};
+```
### PWA
-GitProfile is PWA enabled. The site can be installed as a Progressive Web App.
+GitProfile is PWA enabled. The site can be installed as a Progressive Web App. To turn it off, set `enablePWA` to `false`.
@@ -460,9 +473,9 @@ Your avatar and bio will be fetched from GitHub automatically.
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, Facebook, Instagram, YouTube, Dribbble, Behance, Medium, dev, Stack Overflow, Skype, Telegram, personal website, phone and email.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
social: {
linkedin: 'ariful-alam',
@@ -489,9 +502,9 @@ const config = {
To showcase your skills provide them here.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
skills: ['JavaScript', 'React.js'],
};
@@ -503,9 +516,9 @@ Empty array will hide the skills section.
Provide your job history in `experiences`.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
experiences: [
{
@@ -530,13 +543,13 @@ Empty array will hide the experience section.
### Education
-Provide your education history in `education`.
+Provide your education history in `educations`.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
- education: [
+ educations: [
{
institution: 'Institution name 1',
degree: 'Bachelor of Science',
@@ -559,9 +572,9 @@ Empty array will hide the education section.
Provide your industry certifications in `certifications`.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
certifications: [
{
@@ -580,19 +593,30 @@ Empty array will hide the certifications section.
#### Github Projects
-Your public repo from GitHub will be displayed in the `Github Projects` section automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo.
+- **Automatic Mode:** Seamlessly showcase your top GitHub projects based on stars or last updated date.
+- **Manual Mode:** Choose specific repositories to highlight.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
- github: {
- username: 'arifszn',
- sortBy: 'stars',
- limit: 8,
- exclude: {
- forks: false,
- projects: ['my-project1', 'my-project2'],
+ projects: {
+ github: {
+ display: true, // Display GitHub projects?
+ header: 'Github Projects',
+ mode: 'automatic', // Mode can be: 'automatic' or 'manual'
+ automatic: {
+ sortBy: 'stars', // Sort projects by 'stars' or '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: ['arifszn/my-project1', 'arifszn/my-project2']
+ },
+ },
+ manual: {
+ // Properties for manually specifying projects
+ projects: ['arifszn/gitprofile', 'arifszn/pandora'], // List of repository names to display. example: ['arifszn/my-project1', 'arifszn/my-project2']
+ },
},
},
};
@@ -600,20 +624,37 @@ const config = {
#### External Projects
-In this section you can showcase your external/personal projects.
+- **Highlight Projects Beyond GitHub:** Feature projects hosted on other platforms or personal websites.
+- **Control over Content:** Provide custom titles, descriptions, images, and links for each external project.
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
- externalProjects: [
- {
- title: 'Project Name',
- description: 'Description',
- link: 'https://example.com',
- imageUrl: 'https://via.placeholder.com/250x250',
+ projects: {
+ external: {
+ header: 'My Projects',
+ // To hide the `External Projects` section, keep it empty.
+ projects: [
+ {
+ title: 'Project Name',
+ description:
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
+ imageUrl:
+ 'https://img.freepik.com/free-vector/illustration-gallery-icon_53876-27002.jpg',
+ link: 'https://example.com',
+ },
+ {
+ title: 'Project Name',
+ description:
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
+ imageUrl:
+ 'https://img.freepik.com/free-vector/illustration-gallery-icon_53876-27002.jpg',
+ link: 'https://example.com',
+ },
+ ],
},
- ],
+ },
};
```
@@ -621,9 +662,9 @@ const config = {
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`).
-```js
-// gitprofile.config.js
-const config = {
+```ts
+// gitprofile.config.ts
+const CONFIG = {
// ...
blog: {
source: 'dev',
@@ -633,7 +674,7 @@ const config = {
};
```
-
+
The posts are fetched by [blog.js](https://github.com/arifszn/blog.js).
diff --git a/gitprofile.config.ts b/gitprofile.config.ts
index e72536e..bed1e2c 100644
--- a/gitprofile.config.ts
+++ b/gitprofile.config.ts
@@ -7,7 +7,7 @@ const CONFIG = {
/**
* If you are deploying to https://.github.io/, for example your repository is at https://github.com/arifszn/arifszn.github.io, set base to '/'.
* If you are deploying to https://.github.io//,
- * for example your repository is at https://github.com/arifszn/example, then set base to '/example/'.
+ * for example your repository is at https://github.com/arifszn/portfolio, then set base to '/portfolio/'.
*/
base: '/gitprofile/',
projects: {
@@ -25,7 +25,7 @@ const CONFIG = {
},
manual: {
// Properties for manually specifying projects
- projects: ['arifszn/gitprofile'], // List of repository names to display. example: ['arifszn/my-project1', 'arifszn/my-project2']
+ projects: ['arifszn/gitprofile', 'arifszn/pandora'], // List of repository names to display. example: ['arifszn/my-project1', 'arifszn/my-project2']
},
},
external: {