Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/datacrafts-io/gatsby-opinionated-starter

TypeScript, ESLint, jest, testing-library, Storybook, commitizen & commitlint, semantic-release, remark-lint, stylelint, SCSS Modules, Typography.js, GitHub Actions, PWA, Renovate, netlify-ready gatsby starter
https://github.com/datacrafts-io/gatsby-opinionated-starter

commitizen commitlint css-modules eslint gatsby gatsby-starter gatsby-typescript github-actions jest netlify scss semantic-release storybook stylelint testing-library typography

Last synced: 7 days ago
JSON representation

Host: GitHub
URL: https://github.com/datacrafts-io/gatsby-opinionated-starter
Owner: datacrafts-io
License: 0bsd
Created: 2020-07-11T19:58:45.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-10-10T16:58:48.000Z (29 days ago)
Last Synced: 2024-10-18T21:05:49.837Z (20 days ago)
Topics: commitizen, commitlint, css-modules, eslint, gatsby, gatsby-starter, gatsby-typescript, github-actions, jest, netlify, scss, semantic-release, storybook, stylelint, testing-library, typography
Language: TypeScript
Homepage: https://gatsby-opinionated-starter.netlify.app/
Size: 3.21 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
Opinionated Gatsby Starter




  

    TypeScript

    · jest

    · testing-library

    · Storybook

  

  


  

    ESLint + airbnb

    · stylelint

    · remark-lint

    · Prettier

  

  


  

    commitizen

    · commitlint

    · semantic-release

  

  


  

    Netlify-ready

    · GitHub Actions

    · Renovate

    · TypoCI

    · PWA-enabled

    · Typography.js

  





  

        

  

    

  

    



### _Very_ opinionated starter for Gatsby

This is a complex boilerplate for [Gatsby](https://www.gatsbyjs.org/) with conventional commits.

Supports:

- [TypeScript](https://www.typescriptlang.org/)

- [Renovate](https://renovate.whitesourcesoftware.com/)

- [PWA](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)

- [PropTypes](https://github.com/facebook/prop-types)

- [Storybook](https://storybook.js.org/)

- [Typography.js](https://kyleamathews.github.io/typography.js/)

- [Jest](https://jestjs.io/)

- [testing-library](https://testing-library.com/)

- [stylelint](https://stylelint.io/)

- [ESLint](https://eslint.org/)

- [commitizen](https://github.com/commitizen/cz-cli)

- [commitlint](https://github.com/conventional-changelog/commitlint)

- [semantic-release](https://semantic-release.gitbook.io/)

- [Airbnb ESLint config](https://github.com/airbnb/javascript)

- [Prettier support for ESLint](https://github.com/prettier/eslint-plugin-prettier)

- [remark-lint](https://remark.js.org/)

- [Husky](https://github.com/typicode/husky)

- [TypoCI](https://typoci.com/)

- [SCSS](https://sass-lang.com/)

- [(S)CSS Modules](https://github.com/css-modules/css-modules)

- [Netlify](https://www.netlify.com/)

- [GitHub Actions CI](https://github.com/features/actions)

## 🚀 Quick start

1.  **Create a Gatsby site.**

    Firstly, you need to install Gatsby CLI on your machine:

    ```shell

    $ npm i -g gatsby-cli

    ```

    Use the Gatsby CLI to create a new site, specifying a starter.

    ```shell

    # create a new Gatsby site using this starter

    $ gatsby new opinionated-project https://github.com/datacrafts-io/gatsby-opinionated-starter

    ```

1.  **Start developing.**

    In order to run Storybook + Gatsby dev server, navigate into your new site’s directory and start it up.

    ```shell

    $ cd opinionated-project/

    $ npm i -D husky

    $ npm run start

    ```

1. **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](.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](https://www.gatsbyjs.org/). Here are some places to start:

- **For most developers, it is recommended starting with official [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 official documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.

### 💫 Deploy

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/datacrafts-io/gatsby-opinionated-starter)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/datacrafts-io/gatsby-opinionated-starter)