You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-14Lines changed: 10 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,25 +26,21 @@
26
26
27
27
## 🚀 Get Started
28
28
29
-
1.**Install Yarn (if Yarn Package Manager is not available on your machine).**
30
-
31
-
Yarn has an [installation guide](https://yarnpkg.com/en/docs/install) for your specific configuration. Happy knitting!
32
-
33
-
2.**Install dependencies.**
29
+
1.**Install dependencies.**
34
30
35
31
```sh
36
32
# install the dependencies
37
-
yarn install
33
+
npm install
38
34
```
39
35
40
-
3. **Start developing.**
36
+
1. **Start developing.**
41
37
42
38
```sh
43
39
# "start": "gatsby develop"
44
-
yarn start
40
+
npm start
45
41
```
46
42
47
-
4. **Open the source code and start editing!**
43
+
1. **Open the source code and start editing!**
48
44
49
45
Your site is now running at `http://localhost:8000`!
50
46
@@ -77,7 +73,7 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
77
73
78
74
1. **`/node_modules`**: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.
79
75
80
-
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.”
76
+
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."
81
77
82
78
3. **`.gitignore`**: This file tells git which files it should not track/not maintain a version history.
83
79
@@ -89,17 +85,17 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
89
85
90
86
7. **`gatsby-browser.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://next.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
91
87
92
-
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://next.gatsbyjs.org/docs/gatsby-config/) for more detail).
88
+
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://next.gatsbyjs.org/docs/gatsby-config/) for more detail).
93
89
94
90
8. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby node APIs](https://next.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
95
91
96
92
9. **`gatsby-ssr.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://next.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
97
93
98
94
10. **`LICENSE`**: Gatsby is licensed under the MIT license.
99
95
100
-
11. **`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).
96
+
11. **`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).
101
97
102
-
12. **`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.
98
+
12. **`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.
103
99
104
100
13. **`README.md`**: A text file containing useful reference information about your project.
105
101
@@ -123,7 +119,7 @@ Looking for more guidance? Full documentation for Gatsby lives [on the website](
123
119
124
120
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://next.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
125
121
126
-
- **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar.
122
+
- **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the "Guides", API reference, and "Advanced Tutorials" sections in the sidebar.
0 commit comments