> ## 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 File Transfer Pavan

> Clone the File Transfer Pavan repository, configure Supabase environment variables, and run the dev server locally in under five minutes.

You have two ways to start using File Transfer Pavan. The fastest is to open the live app at [https://file-share-05.lovable.app](https://file-share-05.lovable.app); no setup is required. If you want to customize the codebase or run your own instance, follow the steps below to clone the repository, configure your environment, and launch the local dev server.

## Prerequisites

Before you begin, make sure you have the following ready.

* Node.js 18 or newer installed on your machine
* A Supabase project with a database and Storage bucket configured
* A modern browser that supports Progressive Web App installation (Chrome, Edge, Firefox, or Safari)

## Steps

<Steps>
  <Step title="Clone the repository">
    Run the following command to download the source code and enter the project directory.

    ```bash theme={null}
    git clone https://github.com/pavana05/file-transfer-pavan.git && cd file-transfer-pavan
    ```
  </Step>

  <Step title="Install dependencies">
    Choose your preferred package manager and install the project dependencies.

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

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

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

  <Step title="Create environment variables">
    Create a `.env.local` file in the project root and add your Supabase credentials.

    ```bash theme={null}
    VITE_SUPABASE_URL=https://your-project.supabase.co
    VITE_SUPABASE_ANON_KEY=your-anon-key
    VITE_SUPABASE_SERVICE_KEY=your-service-key # Optional, used for admin operations
    VITE_ANALYTICS_ID=your-analytics-id       # Optional, for analytics integration
    VITE_ENVIRONMENT=development
    ```

    Replace the placeholder values with the URL and keys from your Supabase project settings.
  </Step>

  <Step title="Start the dev server">
    Run the development command for your package manager.

    <CodeGroup>
      ```bash npm theme={null}
      npm run dev
      ```

      ```bash pnpm theme={null}
      pnpm dev
      ```

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

    The dev server starts on [http://localhost:8080](http://localhost:8080).
  </Step>

  <Step title="Open the app">
    Navigate to [http://localhost:8080](http://localhost:8080) in your browser. You should see the landing page and be able to sign up or log in.
  </Step>
</Steps>

## Available scripts

| Script | Command | Purpose |
| - | - | - |
| Dev server | `npm run dev` | Runs Vite with Hot Module Replacement (HMR) on port 8080 |
| Production build | `npm run build` | Creates an optimized production build with code splitting |
| Development build | `npm run build:dev` | Creates a development-mode build for debugging |
| Preview | `npm run preview` | Serves the production build locally for verification |
| Lint | `npm run lint` | Runs ESLint across the TypeScript and React source files |

## Production build

When you are ready to deploy, generate a production build and preview it locally to confirm everything works.

```bash theme={null}
npm run build
npm run preview
```

`npm run build` outputs an optimized bundle with code splitting enabled. `npm run preview` starts a local static server so you can test the production artifacts before deploying.

## Deploy to Vercel

You can deploy File Transfer Pavan to Vercel with a few CLI commands.

```bash theme={null}
vercel deploy
vercel env add VITE_SUPABASE_URL
vercel env add VITE_SUPABASE_ANON_KEY
```

After the first deploy, add the required environment variables through the Vercel CLI or the project dashboard. Vercel will rebuild and redeploy automatically.

## Run with Docker

A Dockerfile is included if you prefer a containerized deployment.

```bash theme={null}
docker build -t file-transfer-pavan .
docker run -p 8080:8080 \
  -e VITE_SUPABASE_URL=https://your-project.supabase.co \
  -e VITE_SUPABASE_ANON_KEY=your-anon-key \
  file-transfer-pavan
```

The container exposes port 8080, matching the default dev server port.

<Note>
  The development server runs on port 8080, not 3000. Make sure no other service is occupying that port before you start the app.
</Note>


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