redshoga / gatsby-blog-template

Gatsby blog template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WIP

gatsby-blog-template

This repo created based on redshoga/gatsby-ts-boilerplate.

gatsby-ts-boilerplate

Gatsby + TypeScript + Linter + Formatter + VSCode config + Testing framework + UI component explorer

This project was based on gatsbyjs/gatsby-starter-default.

Example build page: https://gatsby-ts-boilerplate.web.app/

🚀 Quick start

  1. Clone the repo

    git clone git@github.com:redshoga/gatsby-ts-boilerplate your-project-name

    or

    gatsby new your-project-name https://github.com/redshoga/gatsby-ts-boilerplate
  2. Start developing.

    cd your-project-name
    yarn
    yarn start

🐱 Features

🕶 Main features

  • TypeScript (strict: true) (using gatsby-plugin-typescript)
  • Linters, Formatter (ESlint, stylelint, Prettier)
  • Storybook (UI component explorer)
  • Testing framework (Jest + Enzyme)
  • CI config for GitHub Actions
  • Support SCSS (using gatsby-plugin-sass)

🏹 Other features

  • Normalize.css
  • VSCode config (Format _.css, _.scss, _.ts, _.tsx, _.js, _.jsx files on save)
  • Call src/gatsby/node.ts from gatsby-node.js
  • Auto generate query type (using gatsby-plugin-graphql-codegen)
  • Markdown pages sample code (with reference to the official docs)
  • Example built page: https://gatsby-ts-boilerplate.web.app/ (Gatsby Cloud -> Firebase Hosting)

🔥 Default support features from gatsbyjs/gatsby-starter-default

  • PWA + Offline (using gatsby-plugin-manifest, gatsby-plugin-offline)
  • <SeoInfo />: SEO Component (using gatsby-plugin-react-helmet)
  • <Img />: Optimized image component (using gatsby-image)

Recommend VSCode extensions

Please refer to /.vscode/extensions.json.

Recommended pipeline

on PR created

  • Create preview of Storybook (by Netlify) (Optional)
  • Create preview of web (by Gatsby Cloud)
  • Run CI(Continuous Integration) (by GitHub Actions)

on Merge

  • Deploy storybook files to Netlify (by Netlify) (Optional)
  • Deploy web to Firebase Hosting (by Gatsby Cloud)

License

MIT

About

Gatsby blog template

License:MIT License


Languages

Language:TypeScript 72.3%Language:JavaScript 19.1%Language:CSS 8.6%