# Run a first streaming-platform example

Start with the smallest workflow described by the README for **streaming-platform**. Complete [installation and configuration](/docs/up-to-code-streaming-platform/installation-guide) first.

## Getting Started

### Prerequisites

- Node.js (v18 or higher)
- pnpm (recommended) or npm

### Installation

1. Clone the repository:
```bash
git clone https://github.com/Up-to-code/streaming-platform.git
cd streaming-platform
```

2. Install dependencies:
```bash
pnpm install
```

3. Start the development server:
```bash
pnpm dev
```

4. Open [http://localhost:3000](http://localhost:3000) in your browser.

## Verify your changes

The root manifest provides this check:

```sh
npm run build
```

Read any errors before continuing. Build and type checks verify source consistency; exercise the README example to verify the behavior you need.

## Next task

[Read the usage guide](/docs/up-to-code-streaming-platform/usage-guide) for the documented components, configuration, and source layout.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/streaming-platform)
- [Original README](https://github.com/Up-to-code/streaming-platform/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/streaming-platform/issues)
- [Open the project website](https://streaming-platform-nine.vercel.app)
