Get started

Install, build and preview a WOWW project using the verified framework toolchain.

Requirements

• Node.js 20.9 or newer
• npm 10 or newer
• Git and a terminal

Clone and install

git clone https://github.com/zskbot/woww.git
cd woww
npm install

Build and test

npm test
npm run build
node dist/cli.js build

The TypeScript compiler writes the framework into dist/. The CLI copies public/, emits static HTML and Markdown routes, generates route/performance manifests, and runs the image pipeline.

Local preview

npm run dev
# default: http://localhost:3000

Set PORT to override the local preview port. The CLI builds before starting its static preview server.

Project structure

app/       # TSX/JSX browser entry points
pages/     # HTML, Markdown and file-system routes
edge/      # Edge route handlers
api/       # API handlers
server/    # SSR route handlers
public/    # Static assets and documentation
woww.config.json

← Documentation home