Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 2.83 KB

README.md

File metadata and controls

126 lines (88 loc) · 2.83 KB
Raw

GitHub Portfolio

If you're struggling to create a portfolio website that looks professional, you don't have to search any further. You can use this GitHub Portfolio template to create your very own personalized portfolio using just your GitHub username! The website is designed to be user-friendly and easily customizable, which makes it an ideal solution for developers and freelancers alike.

Demo 🎥

httpsgithub abusaid me

View live preview here

Installation ⬇️

You will need to download Git and Node to run this project

Make sure you have the latest version of both Git and Node on your computer.

node --version
git --version


Getting Started 🎯

Fork and Clone the repo

To Fork the repo click on the fork button at the top right of the page. Once the repo is forked open your terminal and perform the following commands

git clone https://github.com/<YOUR GITHUB USERNAME>/github-portfolio.git

cd github-portfolio

Install packages from the root directory

npm install
# or
yarn install

Then, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Usage 🕹️

If you want to use Google Analytics, Please create a new .env file from .env.example file and provide the value.

Eg:

NEXT_PUBLIC_GTM = ""

Now, you have to customize user data in the data folder.

Eg:

export const userData = {
  githubUser: "said7388",
  devUsername: "said7388",
  github: "https://github.com/said7388",
  facebook: "https://www.facebook.com/abusaid.riyaz/",
  linkedIn: "https://www.linkedin.com/in/abu-said-bd/",
  twitter: "https://twitter.com/said7388",
  stackOverflow: "https://stackoverflow.com/users/16840768/abu-said",
  leetcode: "https://leetcode.com/said3812/",
  resume:
    "https://drive.google.com/file/d/1eyutpKFFhJ9X-qpQGKhUNnVRkB5Wer00/view?usp=sharing",
  skills: [
    "React",
    "NextJS",
    "Redux",
    "Express",
    "NestJS",
    "MySql",
    "MongoDB",
    "Postgres",
    "Docker",
    "AWS",
  ],
  timezone: "+6",
};

Packages Used 📦

Used Package List
next
@next/third-parties
axios
react-icons
react-github-calendar
sass
tailwindcss

Disclaimer

In this repository, I have used some open source APIs. All credits go to the owners of those repositories.