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

# Quick start

> Clone, install, and boot the Signalium dev stack against live mainnet — under two minutes.

## Prerequisites

| Tool                              | Version | Install                                                     |
| --------------------------------- | ------- | ----------------------------------------------------------- |
| Node.js                           | 22+     | [nodejs.org](https://nodejs.org) or `nvm install 22`        |
| pnpm                              | 10+     | `curl -fsSL https://get.pnpm.io/install.sh \| sh`           |
| bun                               | 1.3+    | `curl -fsSL https://bun.sh/install \| bash`                 |
| foundry (only for contract tests) | latest  | `curl -L https://foundry.paradigm.xyz \| bash && foundryup` |

## 1. Clone + install

```bash theme={null}
git clone https://github.com/rstfulzz/signalium.git
cd signalium
pnpm install
```

## 2. Configure env

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

Minimum needed to read live mainnet markets:

| Var                            | What it's for                                                                             | Where to get it                                    |
| ------------------------------ | ----------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `OG_NETWORK`                   | Always `mainnet` — Signalium is mainnet-only (Gimo `StakePool` lives on chain id `16661`) | n/a                                                |
| `NEXT_PUBLIC_REOWN_PROJECT_ID` | Wallet connection (Reown AppKit)                                                          | Free at [cloud.reown.com](https://cloud.reown.com) |

To create markets locally you also need:

| Var                                             | What it's for                                                                  |
| ----------------------------------------------- | ------------------------------------------------------------------------------ |
| `X_RAPIDAPI_API_KEY`                            | Pull tweets via [twitter241](https://rapidapi.com/davethebeast/api/twitter241) |
| `OG_COMPUTE_PROVIDER_URL`, `OG_COMPUTE_API_KEY` | DeepSeek V3 inference via [0G Compute](https://docs.0g.ai/0g-compute)          |
| `STORAGE_UPLOADER_PRIVATE_KEY`                  | Pays for sealing judge prompts to 0G Storage                                   |

## 3. Run the stack

```bash theme={null}
pnpm dev
# api on http://localhost:3001
# web on http://localhost:3000
```

Open [http://localhost:3000](http://localhost:3000), connect a wallet, browse markets. The page loads the same on-chain contracts as production at `chainId 16661`.

## 4. (Optional) Run the contract test suite

```bash theme={null}
pnpm --filter @signalium/contracts test
# 138 unit tests, ~3s

# Fork tests against the real Gimo proxy on 0G mainnet
pnpm --filter @signalium/contracts test --fork-url https://evmrpc.0g.ai
# 4 fork tests, ~6s
```

<Card title="Next: Architecture" icon="diagram-project" href="/concepts/architecture">
  See how the web, API, judge worker, contracts, and subgraph fit together.
</Card>
