Skip to content

install.md

Latest commit

 

History

History
50 lines (34 loc) · 1.39 KB

install.md

File metadata and controls

50 lines (34 loc) · 1.39 KB

Installation Guide

Prerequisites

Before installing ForgeTS, ensure your system meets the following requirements:

  • Operating System: macOS, Linux, or Windows (WSL recommended)
  • Node.js: Version 20.0.0 or higher
    • Verify with node -v
  • Package Manager: pnpm (version 8+ recommended)
    • Verify with pnpm -v
    • Install via Corepack: corepack enable (if using Node.js < 16.9.0 install manually) or npm install -g pnpm
  • Git: Version control system

Installation Steps

  1. Clone the Repository

    git clone <repository-url>
cd ForgeTS

  2. Install Dependencies

    We use pnpm for efficient dependency management in this monorepo.

    pnpm install

    This command will:

    • Install dependencies for the root workspace.
    • Install dependencies for all packages in packages/*.
    • Link local packages together.

  3. Verify Installation

    Run the build command to ensure everything is set up correctly.

    pnpm build

    If the build succeeds, your environment is ready.

Common Issues

  • pnpm not found: Ensure pnpm is installed globally or enabled via Corepack.
  • Node version mismatch: Use nvm or fnm to switch to Node.js 20+. The project likely has a .nvmrc or engines field in package.json specifying the version.