https://github.com/projectevergreen/www.greenwoodjs.dev

Documentation website for Greenwood
https://github.com/projectevergreen/www.greenwoodjs.dev

documentation greenwood webcomponents

Last synced: 8 months ago
JSON representation

Documentation website for Greenwood

• Host: GitHub
• URL: https://github.com/projectevergreen/www.greenwoodjs.dev
• Owner: ProjectEvergreen
• Created: 2023-10-13T00:49:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-09-25T02:39:57.000Z (9 months ago)
• Last Synced: 2025-09-25T04:31:34.795Z (9 months ago)
• Topics: documentation, greenwood, webcomponents
• Language: JavaScript
• Homepage: http://www.greenwoodjs.dev
• Size: 5.58 MB
• Stars: 2
• Watchers: 5
• Forks: 10
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# www.greenwoodjs.dev

[![Netlify Status](https://api.netlify.com/api/v1/badges/c7837ab5-866a-4bdf-b538-5adbd17d2a20/deploy-status)](https://app.netlify.com/sites/super-tapioca-5987ce/deploys)

[![Discord Chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://www.greenwoodjs.dev/discord/)

Documentation website for [**GreenwoodJS**](https://www.greenwoodjs.dev/), using GreenwoodJS for development, naturally. Site is hosted on Netlify.

## Setup

1. Clone the repo

1. Have NodeJS LTS installed. (If using **nvm**, run `nvm use` instead)

1. Run `npm ci`

> [!IMPORTANT]

> To contribute to this project, please see our [Contributing guidelines](./CONTRIBUTING.md)

## Workflows

> [!TIP]  

> _See `package.json#scripts` for all available commands._

### Development

To run the site locally for development, run

```sh

$ npm run dev

```

### Production

To build the site for production and view it locally, run:

```sh

$ npm run serve

```

### Storybook

To build storybook for local development, you can run:

```sh

$ npm run story:dev

```

### Testing

To run tests in watch mode, you can run:

```sh

$ npm run test:tdd

```

Otherwise all tests can be run once with:

```sh

$ npm run test

```