# Install and configure dashboard-ui-initializer

Follow the source instructions for **dashboard-ui-initializer**. Read the prerequisites and configuration steps before running an example.

## Get the source

```sh
git clone https://github.com/Up-to-code/dashboard-ui-initializer.git
cd dashboard-ui-initializer
```

## Install dependencies

Use the repository lockfile when choosing a package manager. The command below follows the captured root manifest and lockfiles.

```sh
npm ci
```

## Environment

See the canonical repo reference:

- [Setup and configuration](https://github.com/Up-to-code/dashboard-ui-initializer/SETUP_AND_CONFIGURATION.md)
- [Environment variables](https://github.com/Up-to-code/dashboard-ui-initializer/docs/ENVIRONMENT.md)

Common Workspace variables include:

- `NEXT_PUBLIC_SITE_URL`
- `SITE_URL`
- `BETTER_AUTH_SECRET`
- `NEXT_PUBLIC_CONVEX_URL`
- `CONVEX_URL`
- `NEXT_PUBLIC_CONVEX_SITE_URL`
- `CONVEX_SITE_URL`
- `PARTNER_APPS_ENABLED`
- `PARTNERS_API_BASE_URL`
- `PARTNERS_PLATFORM_SERVICE_TOKEN`
- `PARTNER_OAUTH_ISSUER`
- `PARTNER_OAUTH_AUDIENCE`
- `WORKSPACE_ADMIN_SERVICE_TOKEN`
- `OPENROUTER_API_KEY`
- `UPLOADTHING_TOKEN`
- `NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN`
- `NEXT_PUBLIC_SENTRY_DSN`

Secret values belong in `.env.local`, Vercel, or Convex deployment env. Do not
commit real token values.

## Check the installation

After setup, continue with the [first example](/docs/up-to-code-dashboard-ui-initializer/quick-start-guide). If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/dashboard-ui-initializer)
- [Original README](https://github.com/Up-to-code/dashboard-ui-initializer/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/dashboard-ui-initializer/issues)