DoodlesEpic/HelloGatsby

Simple static content website to learn Gatsby.

β˜… 1Forks 0JavaScriptGitHub β†—Compare

Project website β†—

gatsbygatsbyjswebsite

README

Gatsby

HelloGatsby

This is a simple project built to learn how to work with Gatsby, it was bootstrapped with the hello-world boilerplate, this starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.

πŸš€ Quick start

  1. Start developing.

    Navigate into the site’s directory and start it up.

    git clone https://github.com/DoodlesEpic/HelloGatsby.git
    cd HelloGatsby/
    gatsby develop
  2. Open the source code and start editing!

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

🧐 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
β”œβ”€β”€ gatsby-node.js
β”œβ”€β”€ gatsby-ssr.js
β”œβ”€β”€ LICENSE
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md
  1. /node_modules: This directory contains 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) such as 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: This is a configuration file for Prettier. Prettier is a tool to help 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. LICENSE: This project is licensed under the MIT license.

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

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

  10. README.md: A text file containing useful reference information about the project.

Contributors

DoodlesEpicdependabot[bot]

Issues