Skip to content

Latest commit

 

History

History
46 lines (24 loc) · 1.54 KB

README.md

File metadata and controls

46 lines (24 loc) · 1.54 KB

Project Setup

This document provides guidance on setting up and running the project locally.

Prerequisites

Ensure you have Node.js installed on your system. You can download it from Node.js official website if you haven't already.

Installation

Follow these steps to install the necessary dependencies and run the project:

Step 1: Clone the Repository

First, clone the repository to your local machine:

Step 2: Install Dependencies

Run the following command to install the required dependencies:

npm install --legacy-peer-deps @react-three/fiber @react-three/drei maath react-tilt react-vertical-timeline-component @emailjs/browser framer-motion react-router-dom

This command installs several packages including React Three Fiber for 3D rendering, Drei for additional components and utilities, Math for mathematical operations, Tilt for creating tilt animations, Vertical Timeline Component for displaying vertical timelines, EmailJS for sending emails directly from the frontend, Framer Motion for animations, and React Router DOM for routing.

Step 3: Start the Development Server

After installing the dependencies, start the development server by running:

npm run dev

This command starts the local development server, enabling you to view and interact with the project in your browser.

Contributing

Contributions are welcome! Please feel free to submit pull requests or report issues.

License

This project is licensed under the MIT License - see the LICENSE file for details.