> ## Documentation Index
> Fetch the complete documentation index at: https://docs-sora-frame.vercel.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get your digital photo frame running in minutes

## Get started in three steps

Set up your Sora Digital Photo Frame and start displaying your photos.

### Step 1: Prerequisites and Installation

<AccordionGroup>
  <Accordion icon="terminal" title="Install Node.js">
    Ensure you have **Node.js 18.0** or higher installed on your system.

    Check your version:

    ```bash theme={null}
    node --version
    ```

    Download from [nodejs.org](https://nodejs.org) if needed.
  </Accordion>

  <Accordion icon="download" title="Clone and install">
    1. Clone the repository:

    ```bash theme={null}
    git clone https://github.com/Sorbh/sora-digital-photo-frame.git
    cd sora-digital-photo-frame
    ```

    2. Install dependencies:

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

    <Tip>The installation includes all necessary dependencies for both frontend and backend.</Tip>
  </Accordion>
</AccordionGroup>

### Step 2: Configuration

<AccordionGroup>
  <Accordion icon="gear" title="Environment setup">
    1. Create a `.env` file in the root directory:

    ```bash theme={null}
    cp .env.example .env
    ```

    2. Configure your settings:

    ```env theme={null}
    # Server Configuration
    PORT=3000
    NODE_ENV=development

    # Authentication
    ADMIN_PASSWORD=your_secure_password

    # Upload Configuration
    MAX_FILE_SIZE=10485760
    UPLOAD_DIR=uploads

    # Image Processing
    IMAGE_QUALITY=85
    MAX_RESOLUTION_WIDTH=1920
    MAX_RESOLUTION_HEIGHT=1080
    ```

    <Tip>The default settings work great for most setups!</Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Launch your photo frame

<Accordion icon="rocket" title="Start the application">
  1. Start the server:

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

  2. Open your browser and navigate to:

  ```
  http://localhost:3000
  ```

  3. Your digital photo frame is now running!
</Accordion>

## Next steps

Now that your photo frame is running, explore these features:

<CardGroup cols={2}>
  <Card title="Admin Panel" icon="upload" href="/features/admin-panel">
    Upload and manage your photos with the web-based admin interface.
  </Card>

  <Card title="Keyboard Controls" icon="keyboard" href="/features/keyboard-controls">
    Learn slideshow navigation shortcuts and controls.
  </Card>

  <Card title="Network Setup" icon="network-wired" href="/deployment/network">
    Access your photo frame from other devices on your network.
  </Card>

  <Card title="Configuration Guide" icon="gear" href="/configuration">
    Customize slideshow timing, image quality, and display settings.
  </Card>
</CardGroup>

## Access from other devices

<Note>
  **Network Access**: To view your photo frame from tablets, phones, or other computers, replace `localhost` with your computer's IP address (e.g., `http://192.168.1.100:3000`).
</Note>

## Troubleshooting

<AccordionGroup>
  <Accordion icon="bug" title="Port already in use">
    If port 3000 is already in use, change the `PORT` in your `.env` file:

    ```env theme={null}
    PORT=3001
    ```
  </Accordion>

  <Accordion icon="image" title="Images not displaying">
    * Ensure image files are in the correct format (JPG, PNG, GIF, WebP)
    * Check that the `PHOTOS_PATH` in `.env` points to the correct directory
    * Verify file permissions allow reading
  </Accordion>
</AccordionGroup>