How to add Typescript to GatsbyJS
The following tutorial offers a step by step guide on how to add Typescript to GatsbyJS.
Download the open source starter project available on GitHub using the button below.
Step One: Create a Gatsby Starter Project
Run the following line in terminal and complete the quiz.
npm init gatsby
Step Two: Set the current directory to your project
Set the current directory to the name of your new project. In this case, the project was called my-gatsby-site.
Step Three: Add Typescript
In terminal, run the following line
yarn add typescript @types/node @types/react @types/react-dom @types/jest
Step Four: Add Gatsby's Typescript Plugin
In Terminal, run the following line
yarn add gatsby-plugin-typescript
Step Five: Create your tsconfig.json
In the root of your project, create a tsconfig.json and copy in the file below.
Step Six: Rename files
Looking to add support for Alias's or Paths?
Check out our step by step tutorial.
We are actively looking for feedback on how to improve this resource. Please send us a note to email@example.com with any thoughts or feedback you may have.