<h1><img src="https://www.gatsbyjs.org/Gatsby-Monogram.svg" height="28" /> Gatsby Generator</h1>

[![npm](https://img.shields.io/npm/v/generator-gatsby)](https://www.npmjs.com/package/generator-gatsby)  ![GitHub](https://img.shields.io/github/license/tomorrowstudio/generator-gatsby)

Quickly scaffold your own progressive, lightweight [Gatsby](https://gatsbyjs.org) sites and plugins with configurable generators.

## Site generator

Scaffold out an opinionated, optimised Gastby website stack


### Core Features

- 100/100 Lighthouse scores out of the box
- Lightweight set of style-agnostic functional base components
- Internal generators for pages and components (built on [Plop](https://plopjs.com))
- Basic React CSS Modules and PostCSS support
- [Storybook](https://storybook.js.org/) 5 preconfigured for Gatsby
- [Prettier](https://prettier.io) and [Stylelint](https://github.com/stylelint/stylelint) configured out of the box
- Development build notifications

### Optional extras

- [Netlify](https://netlify.com) deployment configuration (HTTP/2 push, lamda proxying)
- [Prismic](https://prismic.io) source boilerplate with new GraphQL API
- [MobX](https://mobx.js.org/index.html) state management
- Starter CSS design system (built on [Bloom](https://bloom.tomorrowstudio.co))
- Dynamic CSS variables polyfilling
- Style agnostic, React-friendly form components
- Robust video, button, and other base components

## Plugin generator

Scaffold lightweight Gatsby plugins, following best practices from Gatsby recommendations

### Features

- Simple Babel buildstep using [babel-preset-gatsby-package](https://www.npmjs.com/package/babel-preset-gatsby-package)
- [Prettier](https://prettier.io) and [Stylelint](https://github.com/stylelint/stylelint) configured out of the box


## Installation and usage

Install the generator and the `yo` runner globally

```sh
npm i -g generator-gatsby yo
```

Run the site generator by calling gatsby-generator directly

```sh
yo gatsby
```

Run the plugin generator by calling `gatsby:plugin`

```sh
yo gatsby:plugin
```

Then follow the prompts to scaffold your project.


---

Made with ❤️ by [Tomorrow](https://tomorrowstudio.co)
