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

# Installation

> Install the Streampixel Web SDK, import it into your project, and verify a working setup.

This page walks through installing the Streampixel Web SDK from GitHub, importing it, and confirming the install works.

## Install the SDK

<Info>
  The SDK is hosted on GitHub. Make sure you have access to the repository before running the install command.
</Info>

```bash theme={"dark"}
npm install git+https://github.com/infinity-void-metaverse/Streampixel-Web-SDK.git#latest
```

## Import

```javascript theme={"dark"}
import { StreamPixelApplication } from 'streampixelsdk';
```

That's it — you're ready to use the SDK.

## Quick verify

```javascript theme={"dark"}
import { StreamPixelApplication } from 'streampixelsdk';

const { appStream, pixelStreaming } = await StreamPixelApplication({
  appId: 'YOUR_PROJECT_ID',
  AutoConnect: true,
});
```

<Tip>
  If this runs without errors, the SDK is installed correctly.
</Tip>

## Using the example app

The fastest way to get started is to clone the example app, which comes pre-configured.

<Steps>
  <Step title="Clone the example repository">
    ```bash theme={"dark"}
    git clone https://github.com/infinity-void-metaverse/Streampixel-SDK-Example.git
    ```
  </Step>

  <Step title="Install dependencies">
    ```bash theme={"dark"}
    cd Streampixel-SDK-Example
    npm install
    ```
  </Step>

  <Step title="Start the dev server">
    ```bash theme={"dark"}
    npm start
    ```

    Open `http://localhost:3000/YOUR_PROJECT_ID` in your browser.
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="Quick start" href="/resources/web-sdk/getting-started/quick-start">
    Build a minimal working integration in a single HTML file.
  </Card>

  <Card title="Initialization and configuration" href="/resources/web-sdk/core-concepts/initialization">
    Learn the configuration options accepted by `StreamPixelApplication`.
  </Card>
</CardGroup>