Explorer's Gatsby default starter

🚀 Quick start

1. 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 https://github.com/gatsbyjs/gatsby-starter-default

2. Start developing.

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

   cd my-default-starter/
   gatsby develop

3. 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 my-default-starter 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
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
|-- .babelrc
|-- .eslintignore
|-- .eslintrc
|-- .prettierignore
|-- babel-plugin-macros-config.js
|-- postcss.config.js
|-- tailwind.config.js
|-- tsconfig.json

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. /src/utils: This directory contains all of the helper files for setting up application level settings.

4. /src/global.css: global styling for application. Includes tailwind base classes

5. /src/declarations.d.ts: type definitions for modules used inside project

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

7. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

8. .prettierignore: This file tells prettier which files it should not track.

9. .eslintrc: This file is a configuration file for ESLint. ESLint is a linting tool for javascript to help you find and fix problems with your code. By default it is set to work with react, typescript and prettier.

10. .eslintignore: This file tells ESlint which files it should not track.

11. babel-plugin-macros-config.js: This file is a configuration file to make babel-plugin-macros work with Emotion JS & tailwind.marco.

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

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

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

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

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

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

18. postcss.config.js: This file is a configuration file to help integrate tailwindcss to our project. It also takes care of linting styles and uses postcss-preset-env to add vendor prefixes and setup browser support.

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

20. tailwind.config.js: This file is configuration file for tailwindcss framework.

21. tsconfig.json: This file is configuration file for Typescript.

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