diff --git a/.eslintignore b/.eslintignore
deleted file mode 100644
index f77aca5..0000000
--- a/.eslintignore
+++ /dev/null
@@ -1,4 +0,0 @@
-node_modules
-public
-.cache
-coverage
diff --git a/.prettierignore b/.prettierignore
deleted file mode 100644
index 19d4c20..0000000
--- a/.prettierignore
+++ /dev/null
@@ -1,4 +0,0 @@
-node_modules/
-public/
-.cache/
-coverage/
diff --git a/LICENSE b/LICENSE
index 5169a5e..0869e16 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2015 gatsbyjs
+Copyright (c) 2020 Ryan Kes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 114c335..6341a34 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,18 @@
-
-
-
- 
-
-
-
- Gatsby's default starter
-
+# My opinionated Gatsby starter
-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.
+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.
-_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
+## Stuff I added
+
+- [ESLint](https://eslint.org/)
+- [Husky](https://github.com/typicode/husky)
+- [Jest](https://jestjs.io/)
+- [lint-staged](https://github.com/okonet/lint-staged)
+- [Prettier](https://prettier.io/)
+- [Storybook](https://storybook.js.org/)
+- [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
@@ -20,7 +22,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti
```shell
# create a new Gatsby site using the default starter
- gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
+ gatsby new my-default-starter https://github.com/alrayyes/my-opinionated-gatsby-starter
```
1. **Start developing.**
@@ -38,15 +40,19 @@ _Have another more specific idea? You may want to check out our vibrant collecti
_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-default-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!
+ 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 in a Gatsby project.
+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
@@ -58,42 +64,50 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
├── package.json
└── README.md
-1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
+1. **`.storybook`**: This is a configuration directory for [Storybook](https://storybook.js.org/). Storybook is a UI development environment for your UI components.
-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”.
+2. **`/__mocks__`**: This directory will contain all of the [manual mocks](https://jestjs.io/docs/en/manual-mocks) for [Jest](https://jestjs.io/).
-3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
+3. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
-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.
+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. **`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.
+5. **`.eslintrc.json`**: This is a [configuration file](https://eslint.org/docs/user-guide/configuring) for [ESLint](https://eslint.org/). Prettier is a tool to help keep the formatting of your code consistent.
-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.org/docs/gatsby-config/) for more detail).
+6. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
-7. **`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.
+7. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
-8. **`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.
+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. **`LICENSE`**: Gatsby is licensed under the MIT license.
+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. **`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).**
+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. **`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.
+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. **`README.md`**: A text file containing useful reference information about your project.
+12. **`jest.config.js` & `jest-preprocess.js` & `loadershim.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. **`README.md`**: A text file containing useful reference information about your project.
+
+16. **`tsconfig.json`**: This is a [configuration file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for [TypeScript](https://www.typescriptlang.org/).
+
+17. **`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, we recommend starting with our [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.
+- **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 our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
+- **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/gatsbyjs/gatsby-starter-default)
[](https://vercel.com/import/project?template=https://github.com/gatsbyjs/gatsby-starter-default)
-
-
diff --git a/gatsby-config.js b/gatsby-config.js
index ffa42c0..0f6b01b 100644
--- a/gatsby-config.js
+++ b/gatsby-config.js
@@ -1,6 +1,6 @@
module.exports = {
siteMetadata: {
- title: "My Opinionated Gatsby Default Starter",
+ title: "My Opinionated Gatsby Starter",
description:
"Default Gatsby starter with a bunch of stuff that I like to use tacked on.",
author: "@alrayyes",
diff --git a/package.json b/package.json
index f49dc2b..cd221ea 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "gatsby-starter-default",
"private": true,
- "description": "A simple starter to get up and developing quickly with Gatsby",
+ "description": "Opinionated gatsby starter with stuff I use",
"version": "0.1.0",
"author": "Ryan Kes",
"dependencies": {
@@ -74,10 +74,10 @@
},
"repository": {
"type": "git",
- "url": "https://github.com/gatsbyjs/gatsby-starter-default"
+ "url": "https://github.com/alrayyes/my-opinionated-gatsby-starter"
},
"bugs": {
- "url": "https://github.com/gatsbyjs/gatsby/issues"
+ "url": "https://github.com/alrayyes/gatsby/my-opinionated-gatsby-starter"
},
"husky": {
"hooks": {