ladunjexa / reactjs18-3d-shirt

stunning ThreeJS 3D Product website corporate with the incredible power of artificial intelligence built with React & Three.js and OpenAI. ⚡

AI-Powered 3D Product Web

Create your unique and exclusive shirt with brand-new 3D customization tool. Unleash your imagination and define your own style.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

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

🌟 About the Project

This repository houses an stunning ThreeJS 3D Product website corporate with the incredible power of artificial intelligence built with React & Three.js and OpenAI Api.

‼️ Folder Structure

Here is the folder structure of webapp.

AI-Powered-3D-Product-Web/
|- client/
  |-- public/
  |-- src/
    |-- assets/
    |-- canvas/
    |-- components/
    |-- config/
    |-- pages/
    |-- store/
|- server/
  |-- routes/

👾 Tech Stack

(back to top)

🧰 Getting Started

🔑 Environment Variables

In order to use this webapp you have to add some environment variables to .env files, The webapp uses OpenAI's API, so, you've to create OpenAI account and generate api key here, to run this webapp, meet with the conditions below.\

client-side [client/.env]

create .env file in client/ directory & add the following environment variables:

VITE_API_URL=<SERVER_URL>

server-side [server/.env]

create .env file in server/ directory & add the following environment variables:

OPENAI_API_KEY=<OPEN_AI_API_KEY>
PORT=<PORT> // optional, default set to 8080

⚙️ Installation

Step 1:

Download or clone this repo by using the command below:

 https://github.com/ladunjexa/AI-Powered-3D-Product-Web.git

Step 2:

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

  node -v

Step 3:

In both folders (client / server) execute the following command to get the required packages:

  npm install

🏃 Run Locally

Step 1:

Go to server folder and execute the following command in order to start the server:

  npm start

Step 2

Go to client folder and execute the following command in order to run the web application:

  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/AI-Powered-3D-Product-Web

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in webapp:

client-side

• Vite.js
• TailwindCSS
• ThreeJS
• @react-three/drei
• @react-three/fiber
• Framer Motion
• maath
• React Color
• Valtio

server-side

• CORS
• dotenv
• Express.js
• Nodemon
• OpenAI Api

(back to top)