Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.09 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.09 KB

Gatsby Template

GitHub Workflow Status CodeFactor

Starter template to start any Gatsby project. Includes static, unit, integration and e2e testing.

Prerequisites

You'll need Node to run this application and I suggest using NVM. Once installed run nvm use to use the default version.

Installation

yarn

that's it :)

Development

To run the main application in dev mode

yarn start

and you can also run storybook alongside to develop components

yarn storybook

Testing

This template comes built with a variety of tests. To run the entire suite

yarn test

see package.json for individual test runners.

Deployment

When pushing commits to Github, the workflows kick in. The PR workflow will ruin tests to check everything is ok, whilst merges to main will deploy to Github Pages.