mirror of
https://github.com/alrayyes/my-opinionated-gatsby-starter
synced 2023-11-14 15:56:29 +00:00
122 lines
6.7 KiB
Markdown
122 lines
6.7 KiB
Markdown
# My opinionated Gatsby starter
|
||
|
||
Kick off your project with this opinionated 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.
|
||
|
||
## Stuff I added
|
||
|
||
- [Emotion](https://emotion.sh/)
|
||
- [ESLint](https://eslint.org/)
|
||
- [Husky](https://github.com/typicode/husky)
|
||
- [Jest](https://jestjs.io/)
|
||
- [lint-staged](https://github.com/okonet/lint-staged)
|
||
- [PostCss](https://postcss.org/)
|
||
- [Prettier](https://prettier.io/)
|
||
- [Storybook](https://storybook.js.org/)
|
||
- [Tailwind CSS](https://tailwindcss.com/)
|
||
- [TypeScript](https://www.typescriptlang.org/)
|
||
|
||
_Have another more specific idea? You may want to check out the vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
|
||
|
||
## 🚀 Quick start
|
||
|
||
1. **Create a Gatsby site.**
|
||
|
||
Use the Gatsby CLI to create a new site, specifying the default starter.
|
||
|
||
```shell
|
||
# create a new Gatsby site using the default starter
|
||
gatsby new my-default-starter https://github.com/alrayyes/my-opinionated-gatsby-starter
|
||
```
|
||
|
||
1. **Start developing.**
|
||
|
||
Navigate into your new site’s directory and start it up.
|
||
|
||
```shell
|
||
cd my-default-starter/
|
||
gatsby develop
|
||
```
|
||
|
||
1. **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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
|
||
|
||
Open the `my-opinionated-gatsby-starter` directory in your code editor of choice and edit `src/pages/index.tsx`. 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.
|
||
|
||
.
|
||
├── .storybook
|
||
├── __mocks__
|
||
├── node_modules
|
||
├── src
|
||
├── .eslintignore
|
||
├── .eslintrc.json
|
||
├── .gitignore
|
||
├── .prettierrc
|
||
├── gatsby-browser.js
|
||
├── gatsby-config.js
|
||
├── gatsby-node.js
|
||
├── gatsby-ssr.js
|
||
├── LICENSE
|
||
├── package-lock.json
|
||
├── package.json
|
||
├── postcss.config.js
|
||
└── README.md
|
||
|
||
1. **`.storybook`**: This is a configuration directory for [Storybook](https://storybook.js.org/). Storybook is a UI development environment for your UI components.
|
||
|
||
2. **`/__mocks__`**: This directory will contain all of the [manual mocks](https://jestjs.io/docs/en/manual-mocks) for [Jest](https://jestjs.io/).
|
||
|
||
3. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
|
||
|
||
4. **`/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”.
|
||
|
||
5. **`.eslintrc.json` & `.eslintignore`**: These are [configuration files](https://eslint.org/docs/user-guide/configuring) for [ESLint](https://eslint.org/). ESLint is a tool to help keep the formatting of your code consistent.
|
||
|
||
6. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
|
||
|
||
7. **`.prettierrc` & `.prettierignore`**: These are configuration files for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
|
||
|
||
8. **`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.
|
||
|
||
9. **`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).
|
||
|
||
10. **`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.
|
||
|
||
11. **`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.
|
||
|
||
12. **`jest.config.js` & `jest-preprocess.js` & `loadershim.js` & `setup-test-env.js`**: These are configuration files for [Jest](https://jestjs.io/).
|
||
|
||
13. **`LICENSE`**: Gatsby is licensed under the MIT license.
|
||
|
||
14. **`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.
|
||
|
||
15. **`postcss.config.js`**: This is the configuration file for [PostCSS](https://postcss.org/)
|
||
|
||
16. **`README.md`**: A text file containing useful reference information about your project.
|
||
|
||
17. **`tailwind.config.js`**: This is the configuration file for [Tailwind CSS](https://tailwindcss.com/)
|
||
|
||
18. **`tsconfig.json`**: This is a [configuration file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for [TypeScript](https://www.typescriptlang.org/).
|
||
|
||
19. **`yarn.lock`** (See `package.json` below, first). This is an [automatically generated file](https://classic.yarnpkg.com/en/docs/yarn-lock/) based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**
|
||
|
||
## 🎓 Learning Gatsby
|
||
|
||
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
|
||
|
||
- **For most developers, I recommend starting with the [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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 the documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
|
||
|
||
## 💫 Deploy
|
||
|
||
[](https://app.netlify.com/start/deploy?repository=https://github.com/alrayyes/my-opinionated-gatsby-starter)
|
||
|
||
[](https://vercel.com/import/project?template=https://github.com/alrayyes/my-opinionated-gatsby-starter)
|