> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spreadknowledge.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart: set up the SpreadKnowledge workspace

> Install SpreadKnowledge, run the dev server, and execute the required type, build, and docs checks locally.

This quickstart gets a SpreadKnowledge contributor from a clean clone to a running dev server with all required checks green. Follow every step; the checks below are the same gates GitLab CI/CD enforces.

## Prerequisites

<Steps>
  <Step title="Install Node.js">
    Install the Node.js version pinned by the repository (see `.nvmrc` or `engines` in `package.json`).
  </Step>

  <Step title="Install Yarn 1.22.22">
    SpreadKnowledge is locked to Yarn Classic. Install exactly `yarn@1.22.22`; newer Yarn versions are not supported.
  </Step>

  <Step title="Obtain an approved environment config">
    Request the approved `.env` from the platform team. Do not copy environment values between products or accounts.
  </Step>
</Steps>

## Install and run

<Steps>
  <Step title="Install dependencies">
    ```bash theme={null}
    yarn install
    ```
  </Step>

  <Step title="Start the dev server">
    ```bash theme={null}
    yarn dev
    ```

    Local browser-facing URLs must resolve on `localhost`. Unknown hosts are errors, not warnings.
  </Step>

  <Step title="Run required checks">
    ```bash theme={null}
    yarn type-check
    yarn build
    yarn docs:mintlify:check
    ```

    All three must pass before you open a merge request.
  </Step>
</Steps>

<Note>
  Use the DICC launcher to start SpreadKnowledge processes in a consistent, approved shell. DICC ensures the correct Node, Yarn, and environment are active before any command runs.
</Note>

<Tip>
  Any visible change must be corroborated with EyeParity and DIPP visual evidence before review. Capture production against your branch's preview and attach the artifact to your merge request.
</Tip>

## Next steps

<CardGroup cols={2}>
  <Card title="Frontend architecture" icon="cubes" href="/platform/frontend-architecture">
    Learn which package owns what, and where change and proof boundaries fall.
  </Card>

  <Card title="Deployment and visual proof" icon="shield-check" href="/operations/deployment-and-proof">
    Ship through GitLab CI/CD with EyeParity as the reviewer source of truth.
  </Card>
</CardGroup>