Greenwood

Overview

Greenwood is your workbench for the web, embracing web standards from the ground up to empower your stack from front to back. For information on getting started, reviewing our docs, or to learn more about the project and how it works, please visit our website.

Features:

• ⚡ No bundle development. Pages are built on the fly
• 📝 HTML first authoring experience and ESM friendly
• 📖 Server rendering and prerendering support for Web Components
• 📚 Build with friends like Lit, Tailwind and HTMX
• 🎁 Deploy self-hosted or to platforms like Vercel and Netlify
• ⚒️ Extensible via plugins
• ⚙️ Supports SSG, MPA, SPA, SSR and hybrid project types. Including API Routes.

Greenwood is currently working towards a 1.0 release. We would love to have your help building Greenwood! ✌️

Getting Started

Our website has a complete Getting Started guide that will walk you through creating a Greenwood project from scratch.

You can follow along with, or clone and go, the companion repo or try it out live on Stackblitz.

Installation

Greenwood can be installed with your favorite JavaScript package manager.

# npm
npm i -D @greenwood/cli

# yarn
yarn add @greenwood/cli --dev

# pnpm
pnpm add -D @greenwood/cli

Then in your package.json, add the type field and scripts for the CLI:

{
  "type": "module",
  "scripts": {
    "build": "greenwood build",
    "dev": "greenwood develop",
    "serve": "greenwood serve"
  }
}

• greenwood build: Generates a production build of your project
• greenwood develop: Starts a local development server for your project
• greenwood serve: Runs a production server for a production build

Documentation

All of our documentation is on our website, which itself is built by Greenwood.

Contributing

We would love your contribution to Greenwood! To get involved, you can check out our issue tracker for the “good first issue” label, reach out to us on Discord, or start a discussion in our GitHub repo.

License

See the LICENSE file for license rights and limitations (MIT).