alex-camman/1111

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)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/Threejs_3D_Portfolio

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in 3D Portfolio

• Email JS
• Framer Motion
• React Tilt
• React Vertical Timeline Component
• #JSMastery

(back to top)