trucknet-boilerplate-typescript-gatsby

A starter kit for TypeScript-based Gatsby projects with sensible defaults.

This is a starter kit for Gatsby.js websites written in TypeScript. It includes the bare essentials for you to get started (styling, Markdown parsing, minimal toolset).

Features

• TypeScript
• TSLint (with custom TSLint rules)
• Markdown rendering with Remark
• Basic component structure
• Material UI
• JSS
• SVG rendering support
• Netlify CMS integration and deploy
• Sentry error reporting
• i18n using lioness and gatsby-node.js custom configs
• Jest
• Storybook

Geting started

Install this starter (assuming you have gatsby-cli installed) by running the following command:

gatsby new project-name https://github.com/trucknet-io/trucknet-boilerplate-typescript-gatsby

Developing

A nodejs >= 6.0.0 setup with yarn is recommended.

# install dependencies
yarn

# ...or, for npm
npm install

# serve with hot reload at localhost:8000
npm start

# build for production
npm run build

# build for production and push to gh-pages branch
npm run deploy

Credits

Built with Gatsby - the blazing-fast static site generator for React.

Deploy