diegonvs/gatsby-boilerplate

An awesome boilerplate to start projects in Gatsby considering as starter point the development experience of Electric.js 🔥⚡⚡

Gatsby Boilerplate 🚀

Gatsby Boilerplate is a Gatsby starter with a better development experience and the same content creation experience than Electric.js.

Feel free to contribute with issues and PRs!

Documentation

If you want to check the documentation 📚 click on this link.

Setup

0. Clone this repo or use Gatsby command line interface using gatsby new [your_site] https://github.com/diegonvs/gatsby-boilerplate or git clone https://github.com/diegonvs/gatsby-boilerplate.git
1. Make sure that you have yarn installed
2. Navigate to project folder and run yarn
3. Run npm run develop or yarn develop for development mode or run npm run build or yarn build for production mode
4. If you want serve your production build just run npm run serve or yarn serve

gatsby-boilerplate's Issues

Refactor GraphQL queries using Fragments

More infos: https://graphql.org/learn/queries/#fragments

Reading component

Are there any plans to implement a reading component?

I would be happy to help if it is or isn't in progress 😄

Study the possibility to use Chronicler to create release notes

• https://open.nytimes.com/open-source-automating-release-notes-in-github-dd08f964465c
• https://github.com/NYTimes/Chronicler

Bug sidebar's link active when the file.md has the same name

The links of the sidebar appear with the class "active" when there are 2 files (file.md) with the same name in 2 different directories

image1:

image2:

The bug seems to be generated by the file names (image 2)

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Rate Limited

These updates are currently rate limited. Click on a checkbox below to force their creation now.

• Update dependency gh-pages to v4
• Update dependency globby to v13
• Update react monorepo to v18 (major) (react, react-dom)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency prismjs to v1.27.0 [SECURITY]
• Update dependency node-sass to v7 [SECURITY]
• Update dependency classnames to v2.3.1
• Update dependency clay-component to v2.24.1
• Update dependency clay-css to v2.24.2
• Update dependency clay-tooltip to v2.24.1
• Update dependency gatsby-mdx to v0.6.3
• Update dependency gatsby-plugin-zopfli to v1.3.2
• Update dependency gh-pages to v2.2.0
• Update dependency netlify-identity-widget to v1.9.2
• Update dependency rimraf to v2.7.1
• Update gatsby monorepo (gatsby, gatsby-plugin-google-analytics, gatsby-plugin-manifest, gatsby-plugin-offline, gatsby-plugin-react-helmet, gatsby-plugin-sass, gatsby-remark-copy-linked-files, gatsby-remark-prismjs, gatsby-source-filesystem, gatsby-transformer-remark)
• Update mdx monorepo to v0.20.3 (@mdx-js/mdx, @mdx-js/tag)
• Update react monorepo to v16.14.0 (react, react-dom)
• Update dependency @mdx-js/mdx to v2
• Update dependency gatsby-plugin-zopfli to v2
• Update dependency react-helmet to v6
• Update dependency rimraf to v3
• Update gatsby monorepo (major) (gatsby, gatsby-plugin-google-analytics, gatsby-plugin-manifest, gatsby-plugin-offline, gatsby-plugin-react-helmet, gatsby-plugin-sass, gatsby-remark-copy-linked-files, gatsby-remark-prismjs, gatsby-source-filesystem, gatsby-transformer-remark)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

npm

package.json

• @mdx-js/mdx 0.15.7
• @mdx-js/tag 0.18.0
• browser-monads 1.0.0
• classnames 2.2.6
• clay-component 2.14.2
• clay-css 2.14.2
• clay-tooltip 2.15.1
• gatsby 2.0.104
• gatsby-mdx 0.1.4
• gatsby-plugin-google-analytics 2.0.12
• gatsby-plugin-manifest 2.0.15
• gatsby-plugin-offline 2.0.22
• gatsby-plugin-react-helmet 3.0.5
• gatsby-plugin-sass 2.0.8
• gatsby-plugin-zopfli 1.0.4
• gatsby-remark-component 1.1.3
• gatsby-remark-copy-linked-files 2.0.8
• gatsby-remark-prismjs 3.2.3
• gatsby-source-filesystem 2.0.18
• gatsby-transformer-remark 2.2.2
• metal-clipboard 2.0.1
• metal-tabs 2.3.1
• netlify-identity-widget 1.5.4
• node-sass 4.13.0
• nothing 0.1.0
• prismjs 1.17.1
• react 16.8.6
• react-dom 16.8.6
• react-helmet 5.2.1
• wowjs 1.1.3
• gh-pages 2.0.1
• globby 9.2.0
• rimraf 2.6.3
• node >= 8

plugins/gatsby-plugin-meta-redirect/package.json

plugins/gatsby-remark-code-label-extractor/package.json

plugins/gatsby-remark-use-clipboard/package.json

---

• Check this box to trigger a request for Renovate to run again on this repository

gatsby-boilerplate isn't compatible with prefixPaths and gh-pages

Installing dependencies with npm install doesn't work

If you install the dependencies with

npm i

npm will warn you about peer dependencies that need to be manually installed.

If you try to execute the start script with

npm start 

node will throw an error because of missing dependencies

In order to get all the depencies you need to use

yarn

We should avoid using 2 package managers

Instructions to create a new site is missing parameter

Instructions in the README.md file states:

0. Clone this repo or use Gatsby command line interface using gatsby new https://github.com/diegonvs/gatsby-boilerplate

Based on the docs, the right syntax should be gatsby new [site_name] ...

Reuse meta tags on a component

See:

• https://github.com/diegonvs/gatsby-boilerplate/blob/master/src/templates/docs.js#L32
• https://github.com/diegonvs/gatsby-boilerplate/blob/master/src/templates/blog.js#L30
• https://github.com/diegonvs/gatsby-boilerplate/blob/master/src/templates/onboarding.js#L36
• https://github.com/diegonvs/gatsby-boilerplate/blob/master/src/templates/updates.js#L17

Logout link is shown during milliseconds until javascript is loaded

Missing serve script

Instructions in README.md currently state:

3. Run npm run build or yarn build for production mode 3.1 If you want serve your production build just run npm run serve or yarn serve

There is no such serve script right now declared in package.json, though.

Sometimes the build crashes due formatString argument on date

Sometimes the console blows up this error:

GraphQL Error Unknown argument `formatString`

  file: /Users/diegonascimento/workspace/gatsby-boilerplate/src/components/Blog/BlogList/BlogList.js

   1 |
   2 |             query {
   3 |                 allMdx(filter: { fields: { slug: { regex: "/^blog/i"}, title: {  ne: "" } } },
   4 |                     sort: {order:DESC, fields: frontmatter___date}
   5 |                 ) {
   6 |                     edges {
   7 |                         node {
   8 |                             fields {
   9 |                                 slug
  10 |                                 title
> 11 |                                 date(formatString: "MMMM DD, YYYY")
     |                                      ^
  12 |                                 description
  13 |                                 author
  14 |                                 banner
  15 |                             }
  16 |                         }
  17 |                     }
  18 |                 }
  19 |             }
  20 |

 ERROR  Failed to compile with 1 errors                                       21:35:50

 error  in ./src/components/Blog/BlogList/BlogList.js

Module Error (from ./node_modules/eslint-loader/index.js):

/Users/diegonascimento/workspace/gatsby-boilerplate/src/components/Blog/BlogList/BlogList.js
  38:38  error  Unknown argument "formatString" on field "date" of type "fields_2"  graphql/template-strings

✖ 1 problem (1 error, 0 warnings)


 @ ./src/components/Blog/BlogList/index.js 7:0-34 8:15-23
 @ ./src/components/Blog/BlogMain/BlogMain.js
 @ ./src/components/Blog/BlogMain/index.js
 @ ./src/templates/blog.js
 @ ./gatsby/.cache/gatsby-mdx/mdx-wrappers-dir/ba7d3c27d52f0929fb04a0681cc61514--scope-hash-3010b3badc54a9dfa4a4c80e419a41b2.js
 @ ./.cache/sync-requires.js
 @ ./.cache/app.js
 @ multi ./node_modules/react-hot-loader/patch.js (webpack)-hot-middleware/client.js?path=http://localhost:8000/__webpack_hmr&reload=true&overlay=false ./.cache/app

✖ ｢wdm｣:
ERROR in ./src/components/Blog/BlogList/BlogList.js
Module Error (from ./node_modules/eslint-loader/index.js):

/Users/diegonascimento/workspace/gatsby-boilerplate/src/components/Blog/BlogList/BlogList.js
  38:38  error  Unknown argument "formatString" on field "date" of type "fields_2"  graphql/template-strings

✖ 1 problem (1 error, 0 warnings)