Local Setup

What it covers

This path is for maintainers, internal adopters, and self-hosting operators who want more control than the browser or PWA flows provide.

Workspace prerequisites

• Node.js >=20 <23
• npm >=10
• a local checkout of the repository

Basic local workflow

1. Clone the repository.
2. Install workspace dependencies.
3. Start the surface you want to work on.

git clone https://github.com/groupsum/markdown_workspace.git
cd markdown_workspace
npm install --ignore-scripts

Common local commands

Run the client during development:

npm run dev:client

Run the lander during development:

npm run dev:mdwrkcom

Build the client:

npm run build -w apps/client

Build the lander:

npm run build -w apps/mdwrkcom

Self-hosting notes

The lander is a static site build. Set VITE_SITE_URL at build time so robots.txt and sitemap.xml use the correct public origin.

VITE_SITE_URL=https://mdwrk.com npm run build -w apps/mdwrkcom

The public lander is intended to sit behind a reverse proxy. Docker Compose in this repository must keep services internal-only rather than exposing ports directly.

When to choose another path

Choose browser use or the PWA route when you just want to write. Choose standalone modules when you want package reuse without running the whole repository workspace.