10 |
11 | Kick off your project with this default 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.
12 |
13 | _Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.com/docs/gatsby-starters/)._
14 |
15 | ## 🚀 Quick start
16 |
17 | 1. **Create a Gatsby site.**
18 |
19 | Use the Gatsby CLI to create a new site, specifying the default starter.
20 |
21 | ```shell
22 | # create a new Gatsby site using the default starter
23 | gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
24 | ```
25 |
26 | 1. **Start developing.**
27 |
28 | Navigate into your new site’s directory and start it up.
29 |
30 | ```shell
31 | cd my-default-starter/
32 | gatsby develop
33 | ```
34 |
35 | 1. **Open the source code and start editing!**
36 |
37 | Your site is now running at `http://localhost:8000`!
38 |
39 | _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](https://www.gatsbyjs.com/tutorial/part-five/#introducing-graphiql)._
40 |
41 | 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!
42 |
43 | ## 🧐 What's inside?
44 |
45 | A quick look at the top-level files and directories you'll see in a Gatsby project.
46 |
47 | .
48 | ├── node_modules
49 | ├── src
50 | ├── .gitignore
51 | ├── .prettierrc
52 | ├── gatsby-browser.js
53 | ├── gatsby-config.js
54 | ├── gatsby-node.js
55 | ├── gatsby-ssr.js
56 | ├── LICENSE
57 | ├── package-lock.json
58 | ├── package.json
59 | └── README.md
60 |
61 | 1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
62 |
63 | 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”.
64 |
65 | 3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
66 |
67 | 4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
68 |
69 | 5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
70 |
71 | 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](https://www.gatsbyjs.com/docs/gatsby-config/) for more detail).
72 |
73 | 7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.com/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
74 |
75 | 8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.com/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
76 |
77 | 9. **`LICENSE`**: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license.
78 |
79 | 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).**
80 |
81 | 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.
82 |
83 | 12. **`README.md`**: A text file containing useful reference information about your project.
84 |
85 | ## 🎓 Learning Gatsby
86 |
87 | Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.com/). Here are some places to start:
88 |
89 | - **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
90 |
91 | - **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
92 |
93 | ## 💫 Deploy
94 |
95 | [](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)
96 |
97 | [](https://vercel.com/import/project?template=https://github.com/gatsbyjs/gatsby-starter-default)
98 |
99 |
100 |
--------------------------------------------------------------------------------
/gatsby-browser.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Implement Gatsby's Browser APIs in this file.
3 | *
4 | * See: https://www.gatsbyjs.org/docs/browser-apis/
5 | */
6 |
7 | // You can delete this file if you're not using it
8 |
--------------------------------------------------------------------------------
/gatsby-config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | siteMetadata: {
3 | title: `Gatsby Default Starter`,
4 | description: `Kick off your next, great Gatsby project with this default starter. This barebones starter ships with the main Gatsby configuration files you might need.`,
5 | author: `@gatsbyjs`,
6 | },
7 | plugins: [
8 | `gatsby-plugin-react-helmet`,
9 | {
10 | resolve: `gatsby-source-filesystem`,
11 | options: {
12 | name: `images`,
13 | path: `${__dirname}/src/images`,
14 | },
15 | },
16 | `gatsby-transformer-sharp`,
17 | `gatsby-plugin-sharp`,
18 | {
19 | resolve: `gatsby-plugin-manifest`,
20 | options: {
21 | name: `gatsby-starter-default`,
22 | short_name: `starter`,
23 | start_url: `/`,
24 | background_color: `#663399`,
25 | theme_color: `#663399`,
26 | display: `minimal-ui`,
27 | icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
28 | },
29 | },
30 | // this (optional) plugin enables Progressive Web App + Offline functionality
31 | // To learn more, visit: https://gatsby.dev/offline
32 | // `gatsby-plugin-offline`,
33 | ],
34 | }
35 |
--------------------------------------------------------------------------------
/gatsby-node.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Implement Gatsby's Node APIs in this file.
3 | *
4 | * See: https://www.gatsbyjs.org/docs/node-apis/
5 | */
6 |
7 | // You can delete this file if you're not using it
8 |
--------------------------------------------------------------------------------
/gatsby-ssr.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Implement Gatsby's SSR (Server Side Rendering) APIs in this file.
3 | *
4 | * See: https://www.gatsbyjs.org/docs/ssr-apis/
5 | */
6 |
7 | // You can delete this file if you're not using it
8 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "gatsby-starter-default",
3 | "private": true,
4 | "description": "A simple starter to get up and developing quickly with Gatsby",
5 | "version": "0.1.0",
6 | "author": "Kyle Mathews ",
7 | "dependencies": {
8 | "gatsby": "^2.24.50",
9 | "gatsby-image": "^2.4.16",
10 | "gatsby-plugin-manifest": "^2.4.24",
11 | "gatsby-plugin-offline": "^3.2.24",
12 | "gatsby-plugin-react-helmet": "^3.3.10",
13 | "gatsby-plugin-sharp": "^2.6.28",
14 | "gatsby-source-filesystem": "^2.3.25",
15 | "gatsby-transformer-sharp": "^2.5.13",
16 | "prop-types": "^15.7.2",
17 | "react": "^16.12.0",
18 | "react-dom": "^16.12.0",
19 | "react-helmet": "^6.1.0"
20 | },
21 | "devDependencies": {
22 | "prettier": "2.1.0"
23 | },
24 | "keywords": [
25 | "gatsby"
26 | ],
27 | "license": "0BSD",
28 | "scripts": {
29 | "build": "gatsby build",
30 | "develop": "gatsby develop",
31 | "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
32 | "start": "npm run develop",
33 | "serve": "gatsby serve",
34 | "clean": "gatsby clean",
35 | "test": "echo \"Write tests! -> https://gatsby.dev/unit-testing\" && exit 1"
36 | },
37 | "repository": {
38 | "type": "git",
39 | "url": "https://github.com/gatsbyjs/gatsby-starter-default"
40 | },
41 | "bugs": {
42 | "url": "https://github.com/gatsbyjs/gatsby/issues"
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/components/header.js:
--------------------------------------------------------------------------------
1 | import { Link } from "gatsby"
2 | import PropTypes from "prop-types"
3 | import React from "react"
4 |
5 | const Header = ({ siteTitle }) => (
6 |
12 |
You just hit a route that doesn't exist... the sadness.
11 |
12 | )
13 |
14 | export default NotFoundPage
15 |
--------------------------------------------------------------------------------
/src/pages/index.js:
--------------------------------------------------------------------------------
1 | import React from "react"
2 | import { Link } from "gatsby"
3 |
4 | import Layout from "../components/layout"
5 | import Image from "../components/image"
6 | import SEO from "../components/seo"
7 |
8 | const IndexPage = () => (
9 |
10 |
11 |
Hi people
12 |
Welcome to your new Gatsby site.
13 |
Now go build something great.
14 |
15 |
16 |
17 | Go to page 2
18 | Go to "Using TypeScript"
19 |
20 | )
21 |
22 | export default IndexPage
23 |
--------------------------------------------------------------------------------
/src/pages/page-2.js:
--------------------------------------------------------------------------------
1 | import React from "react"
2 | import { Link } from "gatsby"
3 |
4 | import Layout from "../components/layout"
5 | import SEO from "../components/seo"
6 |
7 | const SecondPage = () => (
8 |
9 |
10 |
Hi from the second page
11 |
Welcome to page 2
12 | Go back to the homepage
13 |
14 | )
15 |
16 | export default SecondPage
17 |
--------------------------------------------------------------------------------
/src/pages/using-typescript.tsx:
--------------------------------------------------------------------------------
1 | // If you don't want to use TypeScript you can delete this file!
2 | import React from "react"
3 | import { PageProps, Link, graphql } from "gatsby"
4 |
5 | import Layout from "../components/layout"
6 | import SEO from "../components/seo"
7 |
8 | type DataProps = {
9 | site: {
10 | buildTime: string
11 | }
12 | }
13 |
14 | const UsingTypescript: React.FC> = ({ data, path }) => (
15 |
16 |
17 |
Gatsby supports TypeScript by default!
18 |
This means that you can create and write .ts/.tsx files for your pages, components etc. Please note that the gatsby-*.js files (like gatsby-node.js) currently don't support TypeScript yet.
19 |
For type checking you'll want to install typescript via npm and run tsc --init to create a .tsconfig file.
20 |
You're currently on the page "{path}" which was built on {data.site.buildTime}.