Easy to use automatic portfolio builder for every GitHub user!

View Demo · Report Bug · Request Feature

.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://.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 `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/'`). ```ts // gitprofile.config.ts { base: '/', // ... } ``` - **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 `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. > [!NOTE] > If you are going to deploy using **Vercel**, remember to set the `base` as `/`. ```ts // gitprofile.config.ts { base: '/', // ... } ``` [**Not working?**](https://github.com/arifszn/gitprofile/discussions/548) ### 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/` from your browser. > 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. ## 🎨 Customization All the magic happens in the file `gitprofile.config.ts`. Open it and modify it according to your preference. You can leave most of the sections empty if you don't want to display them on your portfolio. ```ts // gitprofile.config.ts const CONFIG = { github: { 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: 'ariful-alam', x: 'arif_szn', mastodon: 'arifszn@mastodon.social', researchGate: '', facebook: '', instagram: '', reddit: '', threads: '', youtube: '', // example: 'pewdiepie' udemy: '', dribbble: '', behance: '', medium: 'arifszn', dev: 'arifszn', stackoverflow: '', // example: '1/jeff-atwood' discord: '', telegram: '', website: 'https://www.arifszn.com', phone: '', email: 'arifulalamszn@gmail.com', }, resume: { fileUrl: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', // Empty fileUrl will hide the `Download Resume` button. }, skills: [ 'PHP', 'Laravel', 'JavaScript', 'React.js', 'Node.js', 'Nest.js', 'MySQL', 'PostgreSQL', 'Git', 'Docker', 'PHPUnit', 'CSS', 'Antd', 'Tailwind', ], experiences: [ { company: 'Company Name', position: 'Position', from: 'September 2021', to: 'Present', companyLink: 'https://example.com', }, { company: 'Company Name', position: 'Position', from: 'July 2019', to: 'August 2021', companyLink: 'https://example.com', }, ], certifications: [ { name: 'Lorem ipsum', body: 'Lorem ipsum dolor sit amet', year: 'March 2022', link: 'https://example.com', }, ], educations: [ { institution: 'Institution Name', degree: 'Degree', from: '2015', to: '2019', }, { institution: 'Institution Name', degree: 'Degree', from: '2012', to: '2014', }, ], publications: [ { title: 'Publication Title', conferenceName: '', journalName: 'Journal Name', authors: 'John Doe, Jane Smith', link: 'https://example.com', description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.', }, { title: 'Publication Title', conferenceName: 'Conference Name', journalName: '', authors: 'John Doe, Jane Smith', link: 'https://example.com', description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.', }, ], // Display articles from your medium or dev account. (Optional) blog: { source: 'dev', // medium | dev username: 'arifszn', // to hide blog section, keep it empty limit: 3, // How many articles to display. Max is 10. }, googleAnalytics: { 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 }, themeConfig: { defaultTheme: 'nord', // 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: false, // Display the ring in Profile picture displayAvatarRing: true, // Available themes. To remove any theme, exclude from here. themes: [ 'light', 'dark', 'cupcake', 'bumblebee', 'emerald', 'corporate', 'synthwave', 'retro', 'cyberpunk', 'valentine', 'halloween', 'garden', 'forest', 'aqua', 'lofi', 'pastel', 'fantasy', 'wireframe', 'black', 'luxury', 'dracula', 'cmyk', 'autumn', 'business', 'acid', 'lemonade', 'night', 'coffee', 'winter', 'dim', 'nord', 'sunset', 'caramellatte', 'abyss', 'silk', 'procyon', ], }, // Optional Footer. Supports plain text or HTML. footer: `Made with GitProfile and ❤️`, enablePWA: true, }; export default CONFIG; ``` ### Themes There are 37 themes available that can be selected from the dropdown. The default theme can be specified. ```ts // gitprofile.config.ts const CONFIG = { // ... themeConfig: { defaultTheme: 'light', // ... }, }; ```

You can create your own custom theme by modifying the CSS variables in `src/assets/index.css`. Theme `procyon` is defined as a custom theme. ```css /* src/assets/index.css */ @plugin "daisyui/theme" { name: 'procyon'; color-scheme: light; --color-base-100: #e3e3ed; --color-base-200: #d1d1db; --color-base-300: #bfbfc9; --color-base-content: #2a2730; --color-primary: #fc055b; --color-primary-content: #ffffff; --color-secondary: #219aaf; --color-secondary-content: #ffffff; } ``` ### Google Analytics **GitProfile** supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty. ```ts // gitprofile.config.ts const CONFIG = { // ... googleAnalytics: { id: 'G-XXXXXXXXX' }, }; ``` Besides tracking visitors, it will track `click events` on projects and blog posts, and send them to Google Analytics. ### Hotjar **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. ```ts // gitprofile.config.ts const CONFIG = { // ... hotjar: { id: '', snippetVersion: 6 }, }; ``` ### SEO 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. To turn it off, set `enablePWA` to `false`.  ### Avatar and Bio Your avatar and bio will be fetched from GitHub automatically. ### Social Links You can link your social media services you're using, including LinkedIn, X, Mastodon, ResearchGate, Facebook, Instagram, Reddit, Threads, YouTube, Udemy, Dribbble, Behance, Medium, dev, Stack Overflow, Discord, Telegram, personal website, phone and email. ```ts // gitprofile.config.ts const CONFIG = { // ... social: { linkedin: 'ariful-alam', x: 'arif_szn', mastodon: 'arifszn@mastodon.social', researchGate: '', facebook: '', instagram: '', reddit: '', threads: '', youtube: '', udemy: '', dribbble: '', behance: '', medium: '', dev: '', stackoverflow: '', discord: '', telegram: '', website: '', phone: '', email: '', }, }; ``` ### Skills To showcase your skills provide them here. ```ts // gitprofile.config.ts const CONFIG = { // ... skills: ['JavaScript', 'React.js'], }; ``` Empty array will hide the skills section. ### Experience Provide your job history in `experiences`. ```ts // gitprofile.config.ts const CONFIG = { // ... experiences: [ { company: 'Company Name', position: 'Position', from: 'September 2021', to: 'Present', companyLink: 'https://example.com', }, { company: 'Company Name', position: 'Position', from: 'July 2019', to: 'August 2021', companyLink: 'https://example.com', }, ], }; ``` Empty array will hide the experience section. ### Education Provide your education history in `educations`. ```ts // gitprofile.config.ts const CONFIG = { // ... educations: [ { 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. ### Certifications Provide your industry certifications in `certifications`. ```ts // gitprofile.config.ts const CONFIG = { // ... certifications: [ { name: 'Lorem ipsum', body: 'Lorem ipsum dolor sit amet', year: 'March 2022', link: 'https://example.com', }, ], }; ``` Empty array will hide the certifications section. ### Projects #### Github Projects - **Automatic Mode:** Seamlessly showcase your top GitHub projects based on stars or last updated date. - **Manual Mode:** Choose specific repositories to highlight. ```ts // gitprofile.config.ts const CONFIG = { // ... 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 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. ```ts // gitprofile.config.ts const CONFIG = { // ... 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', }, ], }, }, }; ``` ### Publications Provide your academic publishing in `publications`. ```ts // gitprofile.config.ts const CONFIG = { // ... publications: [ { title: 'Publication Title', conferenceName: 'Conference Name', journalName: 'Journal Name', authors: 'John Doe, Jane Smith', link: 'https://example.com', description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.', }, ], }; ``` Empty array will hide the publications section. ### Blog Posts 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`). ```ts // gitprofile.config.ts const CONFIG = { // ... blog: { source: 'dev', username: 'arifszn', limit: 5 }, }; ```  The posts are fetched by [blog.js](https://github.com/arifszn/blog.js). ## 💖 Support

You can show your support by starring this project. ★

## 💡 Contribute To contribute, see the [Contributing guide](https://github.com/arifszn/gitprofile/blob/main/CONTRIBUTING.md). ## 📄 License [MIT](https://github.com/arifszn/gitprofile/blob/main/LICENSE)