NesterNester Documentation

Quick Start

Get the Nester monorepo running locally in under 5 minutes.

Prerequisites

  • Node.js ≥ 20 (22 for dapp frontend)
  • pnpm ≥ 8 (for website)
  • npm ≥ 9 (for dapp frontend)
  • Rust + soroban-cli (for smart contracts)
  • Go ≥ 1.22 (for API backend)

Clone & Install

bash
git clone https://github.com/Suncrest-Labs/nester.git
cd nester

# Website (pnpm)
pnpm install

# Go API Backend (Go)
cd apps/api && go mod download && cd ../..

# DApp frontend (npm)
cd apps/dapp/frontend && npm install && cd ../../..

Run Development Servers

bash
# Website — runs on localhost:3000
pnpm --filter @nester/website dev

# Go API Backend — runs on localhost:8080
cd apps/api && go run cmd/api/main.go

# DApp frontend — runs on localhost:3001
cd apps/dapp/frontend && npm run dev

Build & Verify

bash
# Must pass before pushing — CI runs these exact commands
pnpm --filter @nester/website build && pnpm --filter @nester/website lint
cd apps/dapp/frontend && npm run build && npm run lint && cd ../../..
cd apps/api && go test ./... && cd ../..

Smart Contracts (Soroban)

bash
cd packages/contracts

# Build all contracts
soroban contract build

# Run tests
cargo test

# Deploy to testnet
soroban contract deploy \
  --wasm target/wasm32-unknown-unknown/release/vault.wasm \
  --source <ACCOUNT> \
  --network testnet

Environment Variables

bash
# apps/api/.env
DATABASE_URL=postgresql://user:pass@host:5432/nester
SOROBAN_RPC_URL=https://soroban-testnet.stellar.org
Previous« Architecture OverviewNextSavings Layer »