https://github.com/piersolenski/gatsby-starter

A simple boilerplate for kickstarting Gatsby projects.
https://github.com/piersolenski/gatsby-starter

eslint gatsby lint-staged plop polished prettier styled-components svgr

Last synced: about 2 months ago
JSON representation

A simple boilerplate for kickstarting Gatsby projects.

• Host: GitHub
• URL: https://github.com/piersolenski/gatsby-starter
• Owner: piersolenski
• License: wtfpl
• Created: 2018-12-26T12:26:38.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-02-09T01:59:08.000Z (almost 2 years ago)
• Last Synced: 2024-11-30T06:27:35.547Z (about 2 months ago)
• Topics: eslint, gatsby, lint-staged, plop, polished, prettier, styled-components, svgr
• Language: JavaScript
• Homepage:
• Size: 9.37 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Gatsby Starter

[![Netlify Status](https://api.netlify.com/api/v1/badges/8f96ae93-956c-45ae-b2a8-bb4936ceddd0/deploy-status)](https://app.netlify.com/sites/gatsby-starter-template/deploys)

A simple boilerplate for kickstarting [Gatsby](https://www.gatsbyjs.org/) projects.

Check out the [demo](https://gatsby-starter-template.netlify.com)!

## Features

- [React](https://reactjs.org/)

- [Gatsby](https://www.gatsbyjs.org/)

- [Styled Components](https://styled-components.com/) + [Polished](https://github.com/styled-components/polished)

- [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [lint-staged](https://github.com/okonet/lint-staged) integration

- [SVGR](https://github.com/gregberge/svgr)

- [Plop](https://github.com/plopjs/plop)

## 🚀 Getting started

### Installation

Install the project dependencies.

`npm i`

### Bootstrapping

`npm start`

Bootstraps your project with all the key information.

### Develop

`npm run dev`

Gatsby will start a hot-reloading development environment accessible at `localhost:8000`.

### Building

`npm run build`

Gatsby will perform an optimized production build for your site generating static HTML and per-route JavaScript code bundles.

## Generating code

Gatsy Starter uses [Plop](https://github.com/plopjs/plop) to automate repetivitve workflows, such as creating components or adding a CMS to your project! Run `npm run plop` (or simply `plop` if you have it installed globally) to see your options.