Skip to content

Gatsby Scalable Starter, the starter with all the extras to quick start a scalable GatsbyJS application with TypeScript

License

Notifications You must be signed in to change notification settings

LinnJS/gatsby-scalable-typescript

Repository files navigation

Gatsby

Gatsby Scalable TypeScript

Gatsby starter that uses all the extras to get you up and running with scalable architecture, and workflow as fast as possible.

What's inside?

  • Gatsby (v2)
  • TypeScript (v4)
  • Storybook (v5)
  • Styled Components with Theming (v4)
  • Styled Reset (Advanced)
  • Netlify Config
  • ESLint (Standard)
  • Prettier
  • React to SVG Generator

Quick start

$ gatsby new my-awesome-site https://github.com/LinnJS/gatsby-scalable-typescript

$ cd my-awesome-site
$ yarn start || yarn develop

Details

How to work with svgs

You are welcome to come up with other solutions, but we typically do this:

  1. npm install -g svg-to-react-cli (https://www.npmjs.com/package/svg-to-react-cli)
  2. Navigate to the directory where there is your svg (e.g. example.svg)
  3. Run svgtoreact example Example, this then creates Example.js (the React component for the svg). You can then import this component like any other React commponent.

How to work via styles?

styled-components (https://www.styled-components.com/).

How to theme with styled-components?

  • There is a theme object located in the globals directory, this is where styled are declared
  • ThemeProvider is located in Layout where theme is passed to all child styled-components

ThemeProvider (https://www.styled-components.com/docs/api#themeprovider).

Deploy

Deploy to Netlify

License

Licensed under the MIT License.
See license for more information.

About

Gatsby Scalable Starter, the starter with all the extras to quick start a scalable GatsbyJS application with TypeScript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published