Skip to content

Greenwood is your workbench for the web, embracing web standards from the ground up to empower your stack from front to back.

License

Notifications You must be signed in to change notification settings

ProjectEvergreen/greenwood

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Greenwood

Netlify Status GitHub release GitHub Actions status GitHub issues GitHub license lerna

Overview

Greenwood is your workbench for the web; focused on supporting modern web standards and development to help you create your next project. For information on getting started, reviewing our docs, or to learn more about the project and how it works, please visit our website.

Features:

Greenwood is currently working towards a 1.0 release. If you're interested in learning more about the web and web development (at any skill level!), or interested in checking out our high level roadmap and how Greenwood got where it is today, you can read our State of GreenwoodJS blog post. We would love to have your help making Greenwood! ✌️

Getting Started

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

You can follow along with, or clone and go, the companion repo.

Installation

Greenwood can be installed with your favorite JavaScript package manager.

# npm
npm install @greenwood/cli --save-dev

# yarn
yarn add @greenwood/cli --dev

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

{
  "type": "module",
  "scripts": {
    "build": "greenwood build",
    "start": "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: Generates a production build of your project and runs it on a NodeJS based web server

Documentation

All of our documentation is on our website (which itself is built by Greenwood!). See our website documentation to learn more about:

  • Configuration
  • Pages
  • Templates
  • Component Model
  • Styles and Assets

Contributing

We would love your contribution to Greenwood! Please check out our issue tracker for "good first issue" labels or feel to reach out to us on Slack in the room "Greenwood" or on Twitter.

Built With Greenwood

Site Repo Project Details
The Greenhouse I/O thegreenhouseio/www.thegreenhouse.io Personal portfolio / blog website for @thescientist13 (Greenwood maintainer).
Contributary ContributaryCommunity/www.contributary.community A website (SPA) for browsing open source projects that are open to contributions. Built with Lit and hosted with AWS (S3 / CloudFront).
Analog Studios AnalogStudiosRI/www.analogstudios.net A local music studio SPA website, originally written in Angular 2, recently migrated to Lit. It is currently transitioning to a hybrid static + serverless website showing off the full potential of Greenwood and Web Components. Follow along for all the fun! 🤘

Built a site with Greenwood? Open a PR and add it here!

License

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