diff --git a/README.md b/README.md index 70b4cfa..5f68f41 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,46 @@ -
-GHBanner -
+# VIZ 3D - Product Configurator -# Run and deploy your AI Studio app +An advanced, web-based 3D Product Configurator and Scene Editor built with React, Three.js, and React Three Fiber. -This contains everything you need to run your app locally. +## Core Features -View your app in AI Studio: https://ai.studio/apps/ad0ed820-1760-462d-bbc0-fffffb37ffda +- **3D Scene Editor**: Complete control over 3D scenes, including object transforms, lighting, and environments. +- **Advanced Material & Texture Pipeline**: Features a sophisticated material management system with Triplanar, Planar, Box, and Cylindrical UV mapping projections. +- **AI Image-to-3D Generator**: Native integrations with leading AI generative models (Hunyuan3D, Tripo3D, and Meshy) to seamlessly generate `.glb` 3D assets directly from uploaded reference images. +- **UV Editor**: Powerful 2D UV coordinate editor with live 3D syncing to precisely adjust texture mapping and placement. +- **Drag-and-Drop Imports**: Support for a variety of 3D model formats including `.glb`, `.gltf`, `.fbx`, `.obj`, and `.usdz`. -## Run Locally +## Tech Stack -**Prerequisites:** Node.js +- **Framework**: React (Vite) +- **3D Rendering**: Three.js, `@react-three/fiber`, `@react-three/drei`, `@react-three/postprocessing` +- **Styling**: TailwindCSS +- **State Management**: Zustand +- **AI Integrations**: Tripo3D (v2 API), Meshy (v1 API), Fal.ai (Hunyuan 3D) +## Getting Started -1. Install dependencies: - `npm install` -2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key -3. Run the app: - `npm run dev` +### Prerequisites +- Node.js 18+ +- npm or yarn + +### Installation + +1. Clone the repository: + ```bash + git clone https://scm.ckdigital.in/digifox/cia_product_configurator/cia_product_configurator_frontend_react.git + cd cia_product_configurator_frontend_react + ``` + +2. Install dependencies: + ```bash + npm install + ``` + +3. Start the development server: + ```bash + npm run dev + ``` + +### API Keys +If you plan to use the AI Image-to-3D generation features, you will need to supply API keys for the respective services directly within the application settings UI. These are securely stored in your browser's `localStorage`. diff --git a/antigravity_brain_backup.zip b/antigravity_brain_backup.zip deleted file mode 100644 index 0216fa5..0000000 Binary files a/antigravity_brain_backup.zip and /dev/null differ