Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 4.7 KB

README.md

File metadata and controls

126 lines (94 loc) · 4.7 KB
Raw

My VSCode-Themed Personal Website

Personal Portfolio Built Using Next.js 14 and Material UI: Live Demo

Developed with the software and tools below.

JavaScript Prettier HTML5 GraphQL YAML React
ESLint MongoDB Python TypeScript GitHub%20Actions JSON

🔗 Quick Links

📍 Overview

This repository contains the source code for my personal website. The website is built using Next.js 14 and Material UI.

🎉 Features

VSCode-themed personal website.

  • Pages: Home, Overview, Experience, Education, Projects, Skills, and Resume.
    • Home Page: Apple Watch-themed landing page with bubbles showing my spotify playlist.
    • Overview.md: A markdown file that contains an overview of my personal information.
    • Experience.md: A markdown file that contains my work experience.
    • Education.md: A markdown file that contains my educational background.
    • Projects.md: A markdown file that contains my projects.
    • Skills.md: A markdown file that contains my skills.
  • Resume: A downloadable resume.
  • Dark Mode: Toggle between light and dark themes.

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

  • TypeScript
  • pnpm

⚙️ Installation

  1. Clone the repository:

    git clone https://github.com/pratyush1712/Personal-Website/

  2. Change to the project directory:

    cd Personal-Website

  3. Install the dependencies:

    pnpm install

🤖 Running

Use the following command to run :

pnpm dev

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client. 
    git clone https://github.com/pratyush1712/Personal-Website/
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name. 
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates. 
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository. 
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.