Skip to main content

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.

Prerequisites

ToolVersionInstall
Node.js22+nodejs.org or nvm install 22
pnpm10+curl -fsSL https://get.pnpm.io/install.sh | sh
bun1.3+curl -fsSL https://bun.sh/install | bash
foundry (only for contract tests)latestcurl -L https://foundry.paradigm.xyz | bash && foundryup

1. Clone + install

git clone https://github.com/rstfulzz/signalium.git
cd signalium
pnpm install

2. Configure env

cp .env.example .env
Minimum needed to read live mainnet markets:
VarWhat it’s forWhere to get it
OG_NETWORKmainnet to read live markets, testnet for free devn/a
NEXT_PUBLIC_REOWN_PROJECT_IDWallet connection (Reown AppKit)Free at cloud.reown.com
To create markets locally you also need:
VarWhat it’s for
X_RAPIDAPI_API_KEYPull tweets via twitter241
OG_COMPUTE_PROVIDER_URL, OG_COMPUTE_API_KEYDeepSeek V3 inference via 0G Compute
STORAGE_UPLOADER_PRIVATE_KEYPays for sealing judge prompts to 0G Storage

3. Run the stack

pnpm dev
# api on http://localhost:3001
# web on http://localhost:3000
Open 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

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

Next: Architecture

See how the web, API, judge worker, contracts, and subgraph fit together.