Developer's Portfolio

A personal static website/portfolio template hosted with GitHub Pages, forked from: /hashirshoaeb/home

Table of Contents

• Technology Stack
• Structure
• Sharing
• Prerequisites
• Setup And Deployment
• Contributing

Technology Stack

Dependencies defined in package.json:

Reactjs | Bootstrap | Typist | GitHub API | Instagram API

Structure

• Navigation bar (optional)
• Body
  • Name | Profession
  • Contact / Follow / Find me / Facebook / LinkedIn / GitHub / Instagram / Email / CodePen
  • Resume | About me
• About Me
  • Display picture (optional)
  • About myself, my Interests, Goals and Hobbies
  • Things I'm good at (Skills)
  • Resume button
• Recent Projects (using GitHub API) (optional)
• Leadership (optional)
  • Paragraph
  • Carousel images
• Skills (optional)
  • Technical Skills
  • Soft Skills
• Footer
  • Footer Note (optional)
  • Copyrights - open source
  • Acknowledgements(

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/config.js 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. Rename the repo so that it's <your-username>.github.io

3. Clone the forked repo from your account

4. Open in editor and edit src/editable-stuff/config.js file.

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

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

7. Change URL in package.json file:

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

   Or for deployment at custom domain, refer create-react-app.dev

8. After editing run the following bash commands:

   npm install
   npm start

9. To deploy website, run:

    npm run build
    npm run deploy

   If deployment fails with:

    fatal: A branch named 'live' already exists
   

   simply delete the node_modules/gh-pages/.cache/ folder and try again.

10. Go to your GitHub repo settings and change the GitHub Pages branch to "live"

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

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

12. To change the thumbnail image:

    • Navigate to the "public" folder.
    • There you will see "social-image.png".
    • Delete it.
    • Take a screenshot of your version and rename it "social-image.png" and place it there.

Next time if you make changes, repeat from step 8.