Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 2.99 KB

README.md

File metadata and controls

104 lines (78 loc) · 2.99 KB
Raw

Developer's Portfolio ✨

It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase recent projects.
Site URL / Demo » zijianjoy.github.io/homepage/

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

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/config.js file.

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

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

  6. Change URL in package.json file:

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

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

  7. After editing run the following bash commands:

    npm install
npm start

  8. To deploy website, run:

     npm run build
 npm run deploy

    Or for deployment at <username>.github.io, refer READMEdocs/custom-deployment.md and pages.js

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

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

  10. 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.