Skip to content

Latest commit

 

History

History
120 lines (75 loc) · 6.13 KB

README.md

File metadata and controls

120 lines (75 loc) · 6.13 KB
Raw

Gatsby

Fitzgerald's Gatsby

Built out of my pure curiousity in the JAM Stack & Gatsby

Gatsby boilerplate. Barebones, this ships with the main Gatsby configuration files needed. In honor of the true great Gatsby, F. Scott Fitzgerald

JAM Stack

Gatsby Official Site

Gatsby AWS Hosting via Amazon Web Services Amplify

Getting Started with Gatsby & Wordpress

JS with WP via Calypso

Wordpress Core Gutenberg

Inline-style: F. Scott Fitzgerald

🚀 Quick start

  1. Install the Gatsby CLI.

    The Gatsby CLI helps create new sites using Gatsby starters (like this one!)

    # install the Gatsby CLI globally
npm install -g gatsby-cli

  2. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the default starter.

    # create a new Gatsby site using the default starter
gatsby new my-default-starter

  3. Start developing.

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

    cd my-default-starter/
gatsby develop

  4. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the the fitzgeralds-gatsby directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
└── yarn.lock

  1. /node_modules: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /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), like your site header, or a page template. “Src” is a convention for “source code”.

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

  4. .prettierrc: Configuration file for Prettier, to keep the formatting of your code consistent.

  5. 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.

  6. 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).

  7. 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. Left out of this repo, but you can add one easily called gatsby-node.js

  8. 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. Left out of this repo, but you can add one easily called gatsby-ssr.js

  9. LICENSE: Gatsby is licensed under the MIT license.

  10. 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).

  11. 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.

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

  13. yarn.lock: Yarn is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as package-lock.json, just for a different package management system.

🎓 Learning Gatsby

Looking for further guidance? Full documentation for Gatsby lives on the website. Places to start:

  • For most developers, I recommend starting with in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples head to Gatsby documentation. In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar. Ensure you are looking at the correct doc version for what you are currently using.

💫 Deploy

Deploy to Netlify