> For the complete documentation index, see [llms.txt](https://wiki.4thtech.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.4thtech.io/products/white-label/run-locally.md).

# Fork, configure and run locally

Fork the white-label app, set its environment values and run it on your own computer.

{% hint style="info" %}
**Status: Production-ready, stable.** The 4thTech SDK and the BlockMail & BlockChat white-label apps are supported; no new features are planned. Last release: SDK 0.5.13 (25 Nov 2025).
{% endhint %}

You can run your own copy of BlockMail & BlockChat. It is a Nuxt 3 app (client-side only) that uses the [4thTech SDK](https://wiki.4thtech.io/developers/sdk/architecture.md). The code is on GitHub: [4thtech/white-label-client](https://github.com/4thtech/white-label-client).

```mermaid
flowchart LR
  pages["Nuxt pages and components<br/>mail, chat, settings, dashboard"]
  comp["Composables<br/>useMailClient, useChatClient, useEncryptor, usePollinationX, useWallet"]
  sdk["SDK clients<br/>Mail, Chat, Encryptor, User"]
  wc["Wallet connectors<br/>MetaMask, Coinbase Wallet, WalletConnect"]
  nets["Supported networks (12)"]
  ee["Encryptor extension"]
  px["PollinationX storage"]
  pages --> comp
  comp --> sdk
  comp --> wc
  wc --> nets
  sdk --> nets
  sdk --> ee
  sdk --> px
```

*Figure: How the white-label app is layered, from Nuxt pages down to the SDK, the wallet and the services it talks to.*

## Before you start

* Node.js 22 or later (the project requires it).
* yarn, npm or pnpm.
* A WalletConnect project ID, if you want WalletConnect in the wallet dialog.
* Optional: a PollinationX endpoint and token, if you want to preconfigure storage for all users.

## Steps

1. Fork the repository on GitHub, then clone your fork.
2. Install the dependencies.

```bash
npm install
```

3. Copy `.env.example` to `.env` and fill it in. Use your own values; never commit `.env`.

```bash
cp .env.example .env
```

{% hint style="info" %}
**Screenshot to capture:** `white-label--web--env-file--placeholders--light--1280.png`. The .env file with placeholder values only.
{% endhint %}

| Key                  | What it does                                                                             |
| -------------------- | ---------------------------------------------------------------------------------------- |
| `PORT`, `HOST`       | The port and host the server uses. The example sets `80` and `0.0.0.0`.                  |
| `WALLET_CONNECT_ID`  | Your WalletConnect project ID. Example: `<your-walletconnect-project-id>`.               |
| `MAIL_APP_ID`        | Your app ID for mail. If empty, the SDK uses the zero app ID.                            |
| `CHAT_APP_ID`        | Your app ID for chat.                                                                    |
| `POLLINATIONX_URL`   | A PollinationX endpoint for everyone using your app. Example: `<your-pollinationx-url>`. |
| `POLLINATIONX_TOKEN` | The matching token. Example: `<your-pollinationx-token>`. Keep it out of the repository. |

If you leave `POLLINATIONX_URL` and `POLLINATIONX_TOKEN` empty, each user connects their own PollinationX storage NFT from the dashboard. The token is shipped to the browser, so treat it as visible to your users. See [Set up storage](https://wiki.4thtech.io/products/white-label/storage.md).

{% hint style="warning" %}
Environment values here are placeholders. Never paste real tokens or keys into documentation, issues or screenshots.
{% endhint %}

4. Start the development server.

```bash
npm run dev
```

{% hint style="info" %}
**Screenshot to capture:** `white-label--web--terminal--npm-run-dev--light--1280.png`. Terminal showing the npm run dev output.
{% endhint %}

5. Open the address the server prints. The README uses `http://localhost:3000`. The app starts on the connect page.

{% hint style="info" %}
**Screenshot to capture:** `white-label--web--localhost--app-running--light--1280.png`. The app running on localhost showing the start page.
{% endhint %}

## Contracts and networks

The app supports the 12 networks on the [Networks](https://wiki.4thtech.io/developers/sdk/networks.md) page and uses the OCC v1 contracts configured in the SDK. Addresses are on the [Deployments page](https://wiki.4thtech.io/deployments/deployments-1.md).

## Next

[Brand it](https://wiki.4thtech.io/products/white-label/branding.md), then [build and deploy](https://wiki.4thtech.io/products/white-label/deploy.md).
