Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Latest commit

 

History

History
95 lines (70 loc) · 2.88 KB

README.md

File metadata and controls

95 lines (70 loc) · 2.88 KB
Raw

An opinionated Gatsby starter with custom UI components and Sanity CMS setup to quickly build sites.

DEMO


Netlify Status

Features

  • Gatsby 3
  • Sanity.io CMS integration with a few predefined schemas and widgets
  • SCSS Modules
  • Buletproof primitive component library to get the boring stuff out of the way
  • Useful SCSS utilities mixins to aid development
  • Tests included
  • Storybook 6

Setup

Deploy to Netlify

Use NPM

# Install deps
cd gatsby-starter-picks && npm i && npm i -g @sanity/cli gatsby-cli

# Login to Sanity
sanity login

# Note: Skip this step if you want to look around first
# Removes existing sanity config and sets up a new project
cd studio && sanity init && npm run graphql-deploy && cd ..

# Run
# Studio at http://localhost:3333
# Web frontend at http://localhost:8000
# GraphiQL explorer at http://localhost:8000/___graphql
npm start

# Format and lint
npm run lint
npm run fix

# Build
npm run build

# Deploy Sanity Graphql API
npm run graphql-deploy

# Deploy the Sanity Studio to *.sanity.studio
npm run sanity-deploy

# Run storybook
npm run storybook

Read the docs

Run Storybook to learn how components work

Getting started with Sanity.io

Sanity.io

gatsby-source-sanity

Contribute

  1. Fork it
  2. Create your feature branch git checkout -b feature/fooBar
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/fooBar
  5. Create a new Pull Request

Credits

A massive thanks to @jackbrewer for creating and maintaining Picks component library and SASS utility mixins

This starter is inspired by Sanity