n1kunj1998 / portfolio

Three.js 3D Portfolio

Three.js 3D Portfolio is a modern UI/UX and functional Developer Portfolio Web built with React & Three.js

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Folder Structure
  • Tech Stack
• Getting Started
  • Installation
  • Run Locally
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

This repository houses an well-designed and functional Developer Portfolio Website consisting Navbar, Hero, Overview, Work Experience, Technologies, Projects, Testimonials and Contact sections built with React & Three.js using TailwindCSS ⏭

‼️ Folder Structure

Here is the folder structure of 3D-Portfolio.

Threejs_3D_Portfolio/
|- public/
|- src/
  |-- assets/
  |-- components/
  |-- constants/
  |-- hoc/
  |-- utils/
  |-- App.jsx
  |-- index.css
  |-- main.jsx
  |-- styles.js
|- postcss.config.cjs
|- tailwind.config.cjs
|- vite.config.js

👾 Tech Stack

(back to top)

🧰 Getting Started

⚙️ Installation

Step 1:

Download or clone this repo by using the link below:

 https://github.com/ladunjexa/Threejs_3D_Portfolio.git

Step 2:

3D-Portfolio using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

At the main folder execute the following command in console to get the required dependencies:

  npm install --legacy-peer-deps

Step 4:

At the main folder execute the following command in console to creates a build directory with a production build of 3d portfolio:

  npm run build

Step 5:

At the main folder execute the following command in console to run the server:

  npm run start

🏃 Run Locally

Step 1:

At the main folder execute the following command in console to get the required dependencies:

  npm install --legacy-peer-deps

Step 2:

At the main folder execute the following command in console to run the development server:

  npm run dev

(back to top)