Installation

This guide walks you through setting up the Trading Dashboard Kit from scratch.

System Requirements

• Node.js 18.17 or later
• pnpm (recommended), npm, or yarn
• Git for cloning the repository

Step 1 -- Clone the Repository

Use the private repository URL from your purchase confirmation email:

git clone <your-repo-url> trading-dashboard-kit
cd trading-dashboard-kit

Step 2 -- Install Dependencies

pnpm install

This installs Next.js 16, React 19, Tailwind CSS v4, shadcn/ui components, Recharts, react-resizable-panels, and all utility libraries.

Key Dependencies

Package	Purpose
next 16.x	React framework
react 19.x	UI library
tailwindcss 4.x	CSS framework with oklch tokens
@base-ui/react	Accessible UI primitives
recharts 3.x	Portfolio, analytics, and market charts
react-resizable-panels	Resizable layout panels
lucide-react	Icons
next-themes	Dark mode
sonner	Toast notifications
cmdk	Command palette
class-variance-authority	Component variant management

Step 3 -- Start the Dev Server

pnpm dev

Visit http://localhost:3000 to see the trading dashboard.

Step 4 -- Verify the Setup

Navigate through key pages to confirm everything works:

• / -- Dashboard with portfolio overview, market indices strip, watchlist widget, and activity feed
• /watchlist -- Watchlist with tabbed lists and real-time quotes
• /portfolio -- Holdings table, allocation chart, and performance chart
• /trading/order-entry -- Order form with order book
• /trading/market-depth -- Full order book and depth chart
• /markets/screener -- Stock screener with filters and data table
• /markets/heatmap -- Sector heatmap visualization
• /research/detail -- Stock detail page with tabs for overview, chart, financials, and news
• /social/feed -- Social trading feed with post composer
• /social/leaderboard -- Trader leaderboard with rankings
• /analytics/pnl -- P&L analysis with daily and cumulative charts
• /analytics/risk -- Risk metrics dashboard
• /settings -- Profile and trading preferences
• /login -- Authentication page

Available Scripts

Command	Description
pnpm dev	Start dev server
pnpm build	Create production build
pnpm start	Run production server
pnpm lint	Run ESLint checks

Integrating into an Existing Project

1. Copy components/ into your project (ui, trading, portfolio, dashboard, analytics, markets, research, social, settings, layout, shared, a11y directories)
2. Copy data/seed.ts, data/seed-social.ts, and types/index.ts
3. Copy design tokens from app/globals.css
4. Install the required dependencies from package.json
5. Wire up seed data to your actual market data API, brokerage, or database

Note: All pages use seed data from data/seed.ts and data/seed-social.ts. Replace with your own data source (brokerage API, market data provider, database) when integrating.

Troubleshooting

Port 3000 already in use:

pnpm dev --port 3001

TypeScript errors after installation:

npx tsc --noEmit

Check that tsconfig.json path aliases match your project structure.

shadcn/ui component issues:

The Trading Dashboard Kit uses shadcn/ui v4 with @base-ui/react (not Radix). Components use the render prop pattern instead of asChild. See the shadcn/ui v4 docs for details.