From b048eb2fce59297d47108a6163b1f6681e3586af Mon Sep 17 00:00:00 2001 From: Jeevan Choudhary <134385083+jeevan-2005@users.noreply.github.com> Date: Mon, 5 Aug 2024 15:54:01 +0530 Subject: [PATCH] Update README.md --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f768e33..0c651c2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,45 @@ -# React + Vite +# Personal Portfolio -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +This repository contains my personal portfolio website, built using Vite and React. The portfolio showcases my projects, skills, and experiences as a Computer Science and Engineering student at IIIT Kota. -Currently, two official plugins are available: +## Features -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +- **Modern Tech Stack**: Developed using Vite for fast build times and React for a dynamic user interface. +- **Responsive Design**: Fully responsive design ensuring optimal viewing experience on all devices. +- **Dark Mode**: User-friendly dark mode toggle for a comfortable browsing experience. +- **Interactive UI**: Engaging and interactive user interface with smooth transitions and animations. +- **Projects Showcase**: Detailed presentation of my projects, including live demos and source code links. +- **Skills Section**: Highlight of my technical skills and competencies. +- **Contact Form**: Easy-to-use contact form for potential collaborations or inquiries. + + +## Installation + +To get a local copy up and running, follow these simple steps: + +1. **Clone the repository**: + ```sh + git clone https://github.com/jeevan-2005/g1_choudhary.git + ``` +2. **Navigate to the project directory**: + ```sh + cd developerPortfolio + ``` +3. **Install dependencies**: + ```sh + npm install + ``` +4. **Start the application**: + ```sh + npm run dev + ``` + +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project. +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`). +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`). +4. Push to the Branch (`git push origin feature/AmazingFeature`). +5. Open a Pull Request.