woozlit
WoozieGetting Started

Installation

How to install Woozie on your machine and create your first project in about 30 seconds.

Installation

What you need

  • Node.js 18 or newer (20+ recommended)
  • npm (comes with Node)

That's it.

Install from npm

npm install -g wozie

This gives you the woozie command everywhere on your system. It also sets up VS Code syntax highlighting automatically if you have VS Code installed.

Check that it worked

woozie --help

You should see the list of commands.

Create a project

woozie init myapp
cd myapp
woozie run

Open http://localhost:3000 in your browser. You should see your site running with live reload.

What woozie init creates

myapp/
    main.woozie        -- your homepage
    woozie.rules       -- project config (title, theme, font)
    style.woozie       -- custom CSS overrides (optional)
    pages/             -- additional pages (about, contact, etc.)
        about.woozie
        contact.woozie
    plugins/           -- reusable components you write
    .vscode/           -- editor settings (auto-created)

What's next

Woozie Documentation

Everything you need to know about building websites with Woozie, from first install to production deploy.

Project Structure

What every file and folder in a Woozie project does and when you'd use it.

On this page

Installation
What you need
Install from npm
Check that it worked
Create a project
What woozie init creates
What's next