Getting Started

This guide will help you set up the Nexus environment on your development machine.

Prerequisites

• Node.js: v22 or higher.
• pnpm: Used for package management in this monorepo.
• Docker: Required if you plan to run the protocol simulator lab.

Setup

1. Clone the repository:

   git clone https://github.com/your-org/nexus-project.git
   cd nexus-project

2. Install dependencies:

   pnpm install

3. Start the development environment: To start all apps (Edge OS, Docs, etc.) in parallel:

   pnpm dev

   To start only Edge OS:

   pnpm --filter nexus-edge-os dev

Next Steps

• Explore the Edge OS features.
• Learn how to deploy to production in the Online Deployment Guide or Offline Deployment Guide.