|
1 |
| -# Create Gatsby Web []() [](https://github.com/tripheo0412/create-gatsby-web/blob/master/LICENSE) [](https://github.com/tripheo0412/create-gatsby-web/blob/master/CONTRIBUTING.md) |
| 1 | +# Bootstrap By Create Gatsby Web []() [](https://github.com/tripheo0412/create-gatsby-web/blob/master/LICENSE) [](https://github.com/tripheo0412/create-gatsby-web/blob/master/CONTRIBUTING.md) |
2 | 2 |
|
3 | 3 | Bootstrap a Gatsby Web with pre configured development utilities, SEO optimized, ready support for CI/CD pipeline and CMS.
|
4 | 4 |
|
@@ -107,6 +107,7 @@ It will generate the the initial project structure inside the current folder.<br
|
107 | 107 | ├── .gitignore
|
108 | 108 | ├── .huskyrc.json
|
109 | 109 | ├── .lintstagedrc.json
|
| 110 | +├── .lighthouserc.json |
110 | 111 | ├── .prettierignore
|
111 | 112 | ├── .prettierrc
|
112 | 113 | ├── gatsby-browser.js
|
@@ -143,33 +144,35 @@ It will generate the the initial project structure inside the current folder.<br
|
143 | 144 |
|
144 | 145 | 9. **`.lintstagedrc.json`**: Lint-staged configuration file. Already setup to auto lint and format code before commit.
|
145 | 146 |
|
146 |
| -10. **`.prettierignore`**: This file tells prettier which files it should not track. |
| 147 | +10. **`.lighthouserc.json`**: Lighthouse configuration file. You can adjust passing parameters here. Already configured with optimum parameters. |
147 | 148 |
|
148 |
| -11. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent. |
| 149 | +11. **`.prettierignore`**: This file tells prettier which files it should not track. |
149 | 150 |
|
150 |
| -12. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. |
| 151 | +12. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent. |
151 | 152 |
|
152 |
| -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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). SEO component already preconfigure, only production deployment will get index by Google bots all preview and staging will have **noindex** meta tag. |
| 153 | +13. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. |
153 | 154 |
|
154 |
| -14. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. |
| 155 | +14. **`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.org/docs/gatsby-config/) for more detail). SEO component already preconfigure, only production deployment will get index by Google bots all preview and staging will have **noindex** meta tag. |
155 | 156 |
|
156 |
| -15. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. Preconfigured to convert stylesheet inline to link, preventing too long head which prevent Facebook, Twitter ... scraping data. |
| 157 | +15. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. |
157 | 158 |
|
158 |
| -16. **`jest-preprocess.js`**: This file contains babel options to build gatsby project for Jest testing |
| 159 | +16. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. Preconfigured to convert stylesheet inline to link, preventing too long head which prevent Facebook, Twitter ... scraping data. |
159 | 160 |
|
160 |
| -17. **`jest.config.js`**: This file contains all of Jest configurations. |
| 161 | +17. **`jest-preprocess.js`**: This file contains babel options to build gatsby project for Jest testing |
161 | 162 |
|
162 |
| -18. **`LICENSE`**: This boilerplate is licensed under the MIT license. |
| 163 | +18. **`jest.config.js`**: This file contains all of Jest configurations. |
163 | 164 |
|
164 |
| -19. **`loadershim.js`**: This files contains loader setting for Jest. |
| 165 | +19. **`LICENSE`**: This boilerplate is licensed under the MIT license. |
165 | 166 |
|
166 |
| -20. **`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. |
| 167 | +20. **`loadershim.js`**: This files contains loader setting for Jest. |
167 | 168 |
|
168 |
| -21. **`README.md`**: A text file containing useful reference information about your project. |
| 169 | +21. **`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. |
169 | 170 |
|
170 |
| -22. **`tsconfig.json`**: This file contains all of typescript configurations for type checking. |
| 171 | +22. **`README.md`**: A text file containing useful reference information about your project. |
171 | 172 |
|
172 |
| -23. **`yarn.lock/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).** |
| 173 | +23. **`tsconfig.json`**: This file contains all of typescript configurations for type checking. |
| 174 | + |
| 175 | +24. **`yarn.lock/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).** |
173 | 176 |
|
174 | 177 | All configurations are exposed and predefined folder structures, just write codes, no need to config<br>
|
175 | 178 | Once the installation is done, you can start develop right away!
|
|
0 commit comments