Developer's Portfolio

It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase my recent projects. Site URL / Demo: hashirshoaeb.github.io/home.

Table of Contents

• Technology Stack 🛠️
• Structure ⚓
• Sharing 💗
• Prerequisites 🍪
• Setup And Deployment 🔧
• Contributing 🙌
• Issues
• Upcoming Features / Improvements 🔗
• Showcase 🚀
• Contributors ✨
• License 📄

Technology Stack 🛠️

Dependencies defined in package.json:

Reactjs | Bootstrap | Typist | GitHub API | Instagram API

Structure ⚓

• Body
  • Name | Profession
  • Contact / Follow / Find me / Facebook / LinkedIn / GitHub / Instagram / Email / CodePen
  • Resume
• About Me
  • Display picture (using Instagram API)
  • Interests, Goals and Hobbies
  • Things I'm good at (Skills)
• Projects (using GitHub API)
• Footer
  • Acknowledgements (contributors)
  • Copyrights - open source
  • (quote: Dream big, Think big)

Sharing 💗

Project is open source. Feel free to make your own version. All you need to do is to fork this repository, edit src/editable-stuff/configurations.json and add resume. Mark star ⭐ if you like the project.

Prerequisites 🍪

You should have Node.js and Git installed on your PC. You should also own a GitHub account.

Setup And Deployment 🔧

1. To Get Started, Fork this repository to your GitHub account:

2. Clone the forked repo from your account using:

     git clone https://github.com/<your-username>/home.git

3. Open in editor and edit src/editable-stuff/configurations.json file.

4. Add your resume as <resume.pdf> in place of src/editable-stuff/resume.pdf

5. Change URL in package.json file:

   "homepage": "https://<your-username>.github.io/home"

6. Edit title and meta description in public/index.html.

7. After editing run the following bash commands:

   npm install
   npm start

8. To deploy website run:

    npm run deploy

9. Congrats your site is up and running. To see it live, visit:

     https://<your-username>.github.io/home
   

Contributing 🙌

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Issues

If anyone is looking to make some contribution, the following are issues that you can solve:

• UI improvements
• Grammar check | Spelling mistakes
• Code optimization
• Hover property on social icons
• Routing

Upcoming Features / Improvements 🔗

• Button and place for resume/CV.
• Option: add or not to add Instagram's display picture.
• Number of projects to show in website.
• If the Number of Projects are zero, hide the heading (Recent Projects)
• Make resume optional.

Showcase 🚀

Have you changed something in the code to create your own version? Feel free to share with me, I will list them in this space.

Following awesome people have created their own version.

1. @khizarkhizar version: https://khizarkhizar.github.io/home/

2. @meullah version: https://meullah.github.io/home/

3. @AymunTariq version: https://github.com/AymunTariq/home/

Contributors ✨

Hashir Shoaib

Prithvi Tharun

Cody Bennett

License 📄

LGPL-3.0