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
-
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
-
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
fromgatsby-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)
gatsbyjs/gatsby-starter-default
🔥 Default support features from- PWA + Offline (using
gatsby-plugin-manifest
,gatsby-plugin-offline
) -
<SeoInfo />
: SEO Component (usinggatsby-plugin-react-helmet
) -
<Img />
: Optimized image component (usinggatsby-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