www.greenwoodjs.dev

Documentation website for GreenwoodJS, using GreenwoodJS for development, naturally. Site is hosted on Netlify.

Setup

1. Clone the repo
2. Have NodeJS LTS installed. (If using nvm, run nvm use instead)
3. Run npm ci

Important

To contribute to this project, please see our Contributing guidelines

Workflows

Tip

See package.json#scripts for all available commands.

Development

To run the site locally for development, run

$ npm run dev

Production

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

$ npm run serve

Storybook

To build storybook for local development, you can run:

$ npm run story:dev

Testing

To run tests in watch mode, you can run:

$ npm run test:tdd

Otherwise all tests can be run once with:

$ npm run test