gatsby-opinionated-starter
v1.2.0
Published
A very opinionated TypeScript netlify-ready gatsby starter
Downloads
48
Maintainers
Readme
Very opinionated starter for Gatsby
This is a complex boilerplate for Gatsby with conventional commits.
Supports:
- TypeScript
- Renovate
- PWA
- PropTypes
- Storybook
- Typography.js
- Jest
- testing-library
- stylelint
- ESLint
- commitizen
- commitlint
- semantic-release
- Airbnb ESLint config
- Prettier support for ESLint
- remark-lint
- Husky
- TypoCI
- SCSS
- (S)CSS Modules
- Netlify
- GitHub Actions CI
🚀 Quick start
Create a Gatsby site.
Firstly, you need to install Gatsby CLI on your machine:
$ npm i -g gatsby-cli
Use the Gatsby CLI to create a new site, specifying a starter.
# create a new Gatsby site using this starter $ gatsby new opinionated-project https://github.com/datacrafts-io/gatsby-opinionated-starter
Start developing.
In order to run Storybook + Gatsby dev server, navigate into your new site’s directory and start it up.
$ cd opinionated-project/ $ npm i -D husky $ npm run start
Committing.
In order to commit in a conventional style conveniently you may run
npm run commit
.
:warning: Disabling publishing to npm
There is a file .releaserc.json where you can disable publishing your project
to npm on every new semantic release by setting npmPublish
option to false
🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:
For most developers, it is recommended starting with official in-depth tutorial for creating a site with Gatsby. 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 official documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.