🚀 Quick start

1. Start developing.

   yarn
   yarn start

2. Open the source code and start editing!

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

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

3. Working with NetlifyCMS

   NetlifyCMS is a React application that sites on top of the markdown content in git and provides a user friendly interface for creating, editing, and reviewing proposed content changes.

   To develop new collections and work within NetlifyCMS's static/admin/config.yml file, you can now run a local server and allow the CMS to create and edit your local files

   npx netlify-cms-proxy-server
   # while server is running, in a seperate terminal run
   yarn start

   Now when you navigate to http://localhost:3000/admin/ you will be allowed to log in without authentication, and any file change will only change your local data. No git involved.

🧐 What's inside?

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

.
├── src
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

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

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

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

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

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

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

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

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

• For most developers, we recommend starting with our 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 our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

Developing Components

Check out README in the components directory.

Storybook

A playground for developing components in isolation README