Repository files navigation

Start building your Gatsby project with speed using this Chakra UI boilerplatewith TypeScript.

1. Create a Gatsby site.

   Use the Gatsby CLI(install instructions)to create a new site, specifying the chakra-ui TypeScript starter.

   # create a new Gatsby site using the chakra-ui TypeScript startergatsby new my-chakra-ui-starter https://github.com/chakra-ui/gatsby-starter-chakra-ui-ts

2. Start developing.

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

   cd my-chakra-ui-starter/gatsby develop

3. Open the source code and start editing!

   Your site is now running athttp://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 moreabout using this tool in theGatsby Tutorial.

   Open themy-chakra-ui-starter directory in your code editor of choice andeditsrc/pages/index.js. Save your changes and the browser will update inreal time!

Deploy this starter with one click onNetlify:

A quick look at the top-level files and directories you'll see in a typicalGatsby project.

.├── node_modules├── src├── .gitignore├── gatsby-browser.js├── gatsby-config.js├── gatsby-node.js├── gatsby-ssr.js├── LICENSE├── package.json└── README.md

1. /node_modules: This directory contains all of the modules of code thatyour project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what youwill see on the front-end of your site (what you see in the browser) such asyour site header or a page template.src is a convention for “sourcecode”.

3. .gitignore: This file tells git which files it should not track / notmaintain a version history for.

4. gatsby-browser.js: This file is where Gatsby expects to find any usageof theGatsby browser APIs(if any). These allow customization/extension of default Gatsby settingsaffecting the browser.

5. gatsby-config.js: This is the main configuration file for a Gatsbysite. This is where you can specify information about your site (metadata)like the site title and description, which Gatsby plugins you’d like toinclude, etc. (Check out theconfig docsfor more detail).

6. gatsby-node.js: This file is where Gatsby expects to find any usage oftheGatsby Node APIs(if any). These allow customization/extension of default Gatsby settingsaffecting pieces of the site build process.

7. gatsby-ssr.js: This file is where Gatsby expects to find any usage oftheGatsby server-side rendering APIs(if any). These allow customization of default Gatsby settings affectingserver-side rendering.

8. LICENSE: This Gatsby starter is licensed under the 0BSD license. Thismeans that you can see this file as a placeholder and replace it with yourown license.

9. package.json: A manifest file for Node.js projects, which includesthings like metadata (the project’s name, author, etc). This manifest is hownpm knows which packages to install for your project.

10. README.md: A text file containing useful reference information aboutyour project.

Looking for more guidance? Full documentation for Gatsby liveson the website. Here are some places to start:

• For most developers, we recommend starting with ourin-depth tutorial for creating a site with Gatsby.It starts with zero assumptions about your level of ability and walks throughevery step of the process.

• To dive straight into code samples, headto our documentation. In particular, checkout theGuides,API Reference, andAdvanced Tutorials sections in thesidebar.

You can find full documentation for Chakra UI atchakra-ui.com.

• The setup needed for the library to work with Gatsby is already done for you.Visit theGetting Started - Gatsbyguide for more options.
• TheChakra CLI is available toyou to generate typings for your custom theme tokens, which is great for IDEautocompletion!

Build, Deploy, and Host On Netlify

The fastest way to combine your favorite tools and APIs to build the fastestsites, stores, and apps for the web. And also the best place to build, deploy,and host your Gatsby sites.