> ## Documentation Index
> Fetch the complete documentation index at: https://pavan-c90e8846.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started with AI 3D Model Generator

> Start using AI 3D Model Generator instantly via the live app, or run it locally with pnpm. Clone, configure, and generate 3D models in minutes.

You can start generating 3D models in two ways: use the live deployed app with no setup, or run the application locally for full control over the environment and source code.

<CardGroup cols={2}>
  <Card title="Option 1: Live App" icon="globe" href="https://3d-aimg-pavan.vercel.app">
    Visit [https://3d-aimg-pavan.vercel.app](https://3d-aimg-pavan.vercel.app) to start generating immediately. No installation, configuration, or API key setup required on your end.
  </Card>

  <Card title="Option 2: Local Development" icon="code">
    Clone the repository and run the app on your machine for custom development, private deployments, or deeper integration with your workflow.
  </Card>
</CardGroup>

## Prerequisites for Local Setup

Before running locally, make sure you have the following installed:

* **Node.js 18+** (LTS recommended)
* **pnpm** (recommended), or npm / yarn as alternatives
* **Rodin API credentials** (API key from [Rodin AI](https://rodin.ai))

## Local Setup

Follow these steps to get the application running on your local machine.

<Steps>
  <Step title="Clone the repository">
    Clone the project from GitHub and navigate into the project directory:

    ```bash theme={null}
    git clone https://github.com/pavana05/ai-3d-model.git && cd ai-3d-model
    ```
  </Step>

  <Step title="Install dependencies">
    Install all required packages using your preferred package manager:

    <CodeGroup>
      ```bash pnpm theme={null}
      pnpm install
      ```

      ```bash npm theme={null}
      npm install
      ```

      ```bash yarn theme={null}
      yarn install
      ```
    </CodeGroup>
  </Step>

  <Step title="Configure environment variables">
    Create a `.env.local` file in the project root with the following variables:

    ```bash theme={null}
    NEXT_PUBLIC_RODIN_API_KEY=your_api_key_here
    NEXT_PUBLIC_RODIN_API_URL=https://api.rodin.ai
    NEXT_PUBLIC_APP_URL=http://localhost:3000
    NEXT_PUBLIC_ANALYTICS_ID=your_analytics_id_optional
    ```

    Replace `your_api_key_here` with your actual Rodin AI API key. The analytics ID is optional and only needed if you are tracking usage externally.
  </Step>

  <Step title="Start the development server">
    Run the Next.js development server:

    ```bash theme={null}
    pnpm dev
    ```
  </Step>

  <Step title="Open the app">
    Navigate to [http://localhost:3000](http://localhost:3000) in your browser. You should see the AI 3D Model Generator interface ready for use.
  </Step>
</Steps>

## Available Scripts

| Script | Command | Purpose |
| - | - | - |
| Dev server | `pnpm dev` | Start the Next.js development server with hot reloading |
| Production build | `pnpm build` | Compile an optimized production build |
| Production server | `pnpm start` | Serve the production build on the configured port |
| Lint | `pnpm lint` | Run ESLint across the codebase |

<Tip>
  ESLint and TypeScript errors are ignored during the build process as configured in `next.config.mjs`. The build will complete even if lint or type issues are present.
</Tip>

## Production Build

To run a production-optimized build locally, first build the application and then start the production server:

```bash theme={null}
pnpm build
pnpm start
```

The production server listens on the port defined in your environment. By default, this is port 3000 when `NEXT_PUBLIC_APP_URL` is set to `http://localhost:3000`.

## Deploy to Vercel

Deploy the application directly to Vercel from your local environment:

```bash theme={null}
vercel deploy
```

After deployment, add your environment variables in the Vercel dashboard or use the CLI:

```bash theme={null}
vercel env add NEXT_PUBLIC_RODIN_API_KEY
vercel env add NEXT_PUBLIC_RODIN_API_URL
vercel env add NEXT_PUBLIC_APP_URL
```

## Docker

You can also run the application inside a Docker container. Build the image and start a container with port mapping:

```bash theme={null}
docker build -t ai-3d-model .
docker run -p 3000:3000 ai-3d-model
```

Once the container is running, open [http://localhost:3000](http://localhost:3000) to access the application.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.