Skip to content

Latest commit

 

History

History
127 lines (85 loc) · 5.69 KB

readme.md

File metadata and controls

127 lines (85 loc) · 5.69 KB

Personal Portfolio

image

Table of Contents 📁

  1. Tech Stack
  2. Implemented Sections
  3. Use as a theme
  4. Contributing
  5. Installation Guide
  6. Sample Git Workflow
  7. References & Inspirations
  8. Illustrations

Tech Stack 🧰

  • Frameworks
  • Libraries/Tools

  • Implemented Sections ☑️

    • Hero Section
    • Skills & Experience
    • Education
    • Projects
    • Blogs
    • Open Source Contributions
    • Extra Curricular
    • Contact Me

    Using as a theme ✨

    Code changes

    Three main things have to be changed to customize it your way (please open an issue if you find more such instances):

    1. Personal Information
    • /src/constants/index.js contains all the personal information one needs to change. Each website section is written as a JavaScript object and is pretty intuitive to change.

    • Icons

    1. Website title and icon
    1. Assets

    Deployment

    You can use Netlify to deploy your site. Follow the instructions in their docs to do so.

    Contributing 🏆

    We welcome contributions in the form of pull requests, issues and documentation. Feel free to help us in any way! ❤️

    Installation Guide 🧑‍💻

    Using Git and Github

    • Fork the repo
    • Clone the forked repository
    • Enter the new portfolio directory with cd portfolio
    • Set the upstream remote to the original repository url so that git knows where to fetch updates from in future: git remote add upstream https://github.com/mittal-parth/personal-portfolio.git

    Install required packages

    • npm install

    Run server

    • npm run dev

    Sample Git Workflow

    • Follow the installation guide to install the software
    • Create a new feature branch with git checkout -b <name-of-your-feature-branch>
    • Make changes and commit them in the feature branch.
    • Once done developing, switch back to the main branch with git checkout main ; pull the latest version of the repo with git pull https://github.com/mittal-parth/personal-portfolio.git main
    • Switch back to the feature branch with git checkout <name-of-your-feature-branch>. Apply the new changes on top of the latest version of the repo with git rebase main
    • Resolve merge conflicts (if any)
    • Push your feature branch upto your remote repo with git push origin <name-of-your-feature-branch>
    • Submit a Pull Request to the main branch.
    • After any questions or changes have been resolved, your contribution would be merged in!

    If you found this repo helpful in anyway, considering giving it a star - it would mean the world to me! 🌟

    References & Inspirations 👏

    Illustrations 🖼️