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

# Contributor setup

> Install dependencies and run DocWriter from source.

Clone the repository and use the pinned Node version:

```sh theme={null}
git clone https://github.com/docwriter-org/docwriter.git
cd docwriter
nvm use
npm install
```

Run the application:

```sh theme={null}
npm run dev
```

Vite listens on port 5173. The same process starts Hocuspocus on port 3001.

Run the checks before opening a change:

```sh theme={null}
npm run check
npm run build
```

No unit test framework is configured. Provider smoke tests live under `e2e/` and require the matching credentials.

Use `npm run dev:workspace -- --no-open /path/to/folder` when the test workspace should not be the repository root.