Skip to content

jongwooo/gatsby-starter-typescript

Repository files navigation

Gatsby

Gatsby’s TypeScript Starter

⚛️ 📄 🚀

TypeScript version of the default Gatsby starter

The default Gatsby starter converted to TypeScript

LICENSE CodeFactor GitHub stars

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI (install instructions) to create a new site, specifying this starter.

    # create a new Gatsby site using gatsby-starter-typescript
    gatsby new my-typescript-starter https://github.com/jongwooo/gatsby-starter-typescript
  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd my-typescript-starter/
    yarn develop
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the my-typescript-starter directory in your code editor of choice and edit src/pages/index.tsx. Save your changes and the browser will update in real time!

🚀 Quick start (Gatsby Cloud)

Deploy this starter with one click on Gatsby Cloud:

Deploy to Gatsby Cloud

✅ Testing

Creating New Tests

One example test has been included in this starter. It can be found under /src/components/__tests__/header.tsx. This test creates a Header component and makes sure it renders correctly. Check out the Jest documentation for how to write more tests.

Running Tests

To run Jest tests on the project, run yarn test on the command line.

💫 Deploy

Build, Deploy, and Host On The Only Cloud Built For Gatsby

Gatsby Cloud is an end-to-end cloud platform specifically built for the Gatsby framework that combines a modern developer experience with an optimized, global edge network.

❗ Code of Conduct

We expect everyone participating in the contributing to abide by Code of Conduct.

🤝 How to Contribute

Check out Contributing guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

🐛 Bug reporting

If you found a bug in this repository, please let me know through the Issue.

📝 License

Licensed under the MIT License.