Skip to content
This repository has been archived by the owner on Jul 8, 2022. It is now read-only.

Starter for Gatsby site. TypeScript, Styled-components, Jest, TS types generation

Notifications You must be signed in to change notification settings

ckomop0x-archived-projects/gatsby-typescript-starter

Repository files navigation

Welcome to Gatsby TypeScript template 👋

Version Documentation Maintenance Twitter: webtime-studio

Starter for Gatsby site. TypeScript, Styled-components, Jest, TS types generation

Technologies

  • Gatsby
  • TypeScript
  • Styled Components
  • GraphQL
  • Prettier
  • Eslint

Files structure

.github/                - github actions
.vscode/                - VSCode files and recommended extensions
__mocks__/              - Jest mocks
src/                    – project files
static/                 – assets and static files
types                   - custom TypeScript types
.editorconfig           - base project formatting
.eslitrc.js             - JS liner setting
.gitignore              - files and folders ignored by Git
.graphqlconfig          - graphql schema config for WebStorm
.prettierignore         - files and folders ignored by prettier
.prettierrc             - prettier settings
apollo.config.js        - Apollo GraphQL cofig
gatsby-browser.js       - Gatsby browser settings
gatsby-config.js        - Gatsby config
index.js                - hm why do we need this file?
jest.config.js          - Jest config
jest-preprocess.js      - Jest babel-config
loadershim.js           - anther Jest config
netlify.toml            - Netlify settings
package.json            - project script and dependencies
README.md               - project description
site-config.js          - website base settings
tsconfig.json           - main TypeScript config
tsconfig.test.json      - TypeScript for tests
yarn.lock               - installed dependencies

Under the hood

  • Webpack
  • SCSS
  • JS с Babel
  • Stylelint, Eslint
  • Prettier

Install

yarn install

Usage

yarn dev

Run tests

yarn test

Author

👤 Pavel Klochkov, paul.klochkov@gmail.com

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Pavel Klochkov, paul.klochkov@gmail.com.

This project is MIT licensed.

About

Starter for Gatsby site. TypeScript, Styled-components, Jest, TS types generation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published