Skip to content

YogeshYKG/Portfolio

Repository files navigation

Portfolio Website

This is a personal portfolio website showcasing projects, skills, and experience. Built with modern web technologies including React, Vite, Tailwind CSS, and Lenis Scroll for smooth scrolling effects.

Table of Contents

Demo

Check out the live website here: Portfolio Website

Features

  • Modern, responsive design with Tailwind CSS.
  • Smooth scrolling effects using Lenis Scroll.
  • Optimized performance with Vite for fast builds and HMR (Hot Module Replacement).
  • Modular and reusable React components.
  • Backend logic written in JavaScript.

Tech Stack

  • Frontend: React, Tailwind CSS
  • Bundler: Vite
  • Scrolling Effect: Lenis Scroll
  • Backend: JavaScript

Getting Started

Follow these steps to set up the project locally.

Prerequisites

Make sure you have the following installed on your system:

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/your-repo.git
    cd your-repo
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Start the development server:

    npm run dev
    # or
    yarn dev
  4. Open your browser and navigate to http://localhost:3000 to view the website.

Usage

Scripts

  • npm run dev: Start the development server.
  • npm run build: Build the project for production.
  • npm run preview: Preview the production build locally.

Directory Structure

src/
├── assets/         # Static assets like images
├── components/     # Reusable React components
│   ├── About.jsx
│   ├── Button.jsx
│   ├── Contact.jsx
│   ├── Footer.jsx
│   ├── Header.jsx
│   ├── Hero.jsx
│   ├── Navbar.jsx
│   ├── ProjectCard.jsx
│   ├── Review.jsx
│   ├── ReviewCard.jsx
│   ├── SkillCard.jsx
│   ├── Skills.jsx
│   └── Work.jsx
├── pages/          # Page-level components
├── styles/         # Global and Tailwind CSS styles
├── App.jsx         # Main application component
├── index.css       # Global styles
└── main.jsx        # Application entry point

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Steps to Contribute

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-name
  3. Make your changes and commit them:
    git commit -m "Add new feature"
  4. Push to your branch:
    git push origin feature-name
  5. Open a pull request on GitHub.

License

This project is licensed under the Apache License 2.0.


Feel free to reach out if you have any questions or suggestions!

Author: YogeshYKG