/kerry-gatsby-starter

Kerry Gatsby Starter allows you to build a simple blog.

Primary LanguageSCSSMIT LicenseMIT

hero

Kerry Gatsby Starter

Use Kerry's Starter to start your next great Gatsby project.This starter is a customized starter of ueno-gatsby-starter. (Thanks @ueno-llcπŸ™)

Quick start

  1. Start developing.

    Navigate into your new site’s directory and start it up.

    cd kerry-gatsby-starter
    npm install
    gatsby develop
  2. Open the source code and start editing! Β΅ Your site is now running at http://localhost:8000!

What's inside?

.
β”œβ”€β”€ node_modules
β”œβ”€β”€ src
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .prettierrc
β”œβ”€β”€ gatsby-browser.js
β”œβ”€β”€ gatsby-config.js
β”œβ”€β”€ gatsby-node.js
β”œβ”€β”€ gatsby-ssr.js
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md
  • /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  • /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for β€œsource code”.

  • .gitignore: This file tells git which files it should not track / not maintain a version history for.

  • gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  • gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  • gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  • gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  • package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  • package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  • README.md: A text file containing useful reference information about your project.