https://github.com/devafortun/portfolio

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/devafortun/portfolio
Owner: devafortun
License: mit
Created: 2025-03-20T12:05:30.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-03-21T04:56:21.000Z (about 1 year ago)
Last Synced: 2025-03-21T05:28:38.712Z (about 1 year ago)
Language: JavaScript
Size: 32.1 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

          



  ![Project Banner](readme_assets/readme_banner.png#gh-dark-mode-only)

  ![Project Banner](readme_assets/readme_banner-light.png#gh-light-mode-only)

  
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

  






# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2-about-the-project)

  * [Folder Structure](#bangbang-folder-structure)

  * [Tech Stack](#space_invader-tech-stack)

- [Getting Started](#toolbox-getting-started)

  * [Installation](#gear-installation)

  * [Run Locally](#running-run-locally)

- [Contributing](#wave-contributing)

- [License](#warning-license)

- [Contact](#handshake-contact)

- [Acknowledgements](#gem-acknowledgements)

  

## :star2: 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 ⏭

### :bangbang: Folder Structure

Here is the folder structure of 3D-Portfolio.

```bash

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

```




### :space_invader: Tech Stack

[![My Skills](https://skillicons.dev/icons?i=js,react,tailwind,threejs)](https://skillicons.dev)

(back to top)


## :toolbox: Getting Started

### :gear: Installation

#### Step 1:

Download or clone this repo by using the link below:

```bash

 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:

```bash

  node -v

```

#### Step 3:

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

```bash

  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:

```bash

  npm run build

```

#### Step 5:

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

```bash

  npm run start

```

### :running: Run Locally

#### Step 1:

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

```bash

  npm install --legacy-peer-deps

```

#### Step 2:

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

```bash

  npm run dev

```

(back to top)


## :wave: Contributing



  



Contributions are always welcome!

See [`contributing.md`](https://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)


## :warning: License

Distributed under the MIT License. See [LICENSE.txt](https://github.com/ladunjexa/Threejs_3D_Portfolio/blob/main/LICENSE) for more information.

(back to top)


## :handshake: Contact

Liron Abutbul - [@lironabutbul6](https://twitter.com/lironabutbul6) - [@ladunjexa](https://t.me/ladunjexa)

Project Link: [https://github.com/ladunjexa/Threejs_3D_Portfolio](https://github.com/ladunjexa/Threejs_3D_Portfolio)

(back to top)


## :gem: Acknowledgements

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

 - [Email JS](https://www.emailjs.com/)

 - [Framer Motion](https://www.framer.com/motion/)

 - [React Tilt](https://www.npmjs.com/package/react-tilt)

 - [React Vertical Timeline Component](https://www.npmjs.com/package/react-vertical-timeline-component)

 - #JSMastery

(back to top)