Basic Gatsby starter kit for orangejellyfish projects
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.babelrc
.editorconfig
.eslintrc
.gitignore
LICENSE
README.md
gatsby-config.js
jest.config.js
package-lock.json
package.json

README.md

gatsby-starter-base

A basic starter kit for Gatsby following orangejellyfish JavaScript best practices. This kit is intended for the development of simple static sites. If you have more complex requirements one of our alternative kits might better suit your needs:

Features

If you have more complex requirements one of our alternative kits, built upon this base, might better suit your needs:

Usage

The kit requires Node (version 8 or above recommended) and npm (version 5.2 or above recommended). If those are available on your system you can use npx to quickly scaffold a new site from the kit:

npx -p gatsby-cli gatsby new $DIR_NAME https://github.com/orangejellyfish/gatsby-starter-base
cd $DIR_NAME
npm start

Conventions

Gatsby is a very flexible tool. In order to reduce some of the configuration overhead associated with such flexibility we favour the following conventions:

  • A "layout" is viewed as a common parent to multiple pages. It is represented as a React component exported from a file in the src/layouts directory.

  • A "page" is viewed as an individual web page. A page is represented as a React component exported from a file in the src/pages directory.

  • Simple components (those that are not pages or layouts and generally receive data as props from ancestor components that pull in data from GraphQL) are placed in the src/components directory.

  • GraphQL fragments are placed in the src/fragments directory. This means all fragments are co-located so you don't have to search through all of your components to find one.