6.2 KiB

Raw Blame History

Gatsby's Typescript + Material-ui starter

Kick off your project with this Material-ui boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React. It includes support for Typescript in front-side and node-side and uses Eslint & Prettier.

This starter don't have any source or style supports, it's your choice.

Have another more specific idea? You may want to check out our vibrant collection of official and community-created starters.

🚀 Quick start

Create a Gatsby site.

Use the Gatsby CLI to create a new site, specifying the default starter.

# create a new Gatsby site using the starter
gatsby new gatsby-material-typescript-starter https://github.com/Junscuzzy/gatsby-material-typescript-starter

Start developing.

Navigate into your new site’s directory and start it up.
```
cd gatsby-material-typescript-starter/
yarn develop
```
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 gatsby-material-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!
Bonus: Check all linters using
```
yarn lint
```
Will execute Prettier, Eslint and Typescript checking

All the commands are in your package.json > scripts.

🧐 What's inside?

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

.
├── .vscode/
├── node_modules/
├── src/
├── static/
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

/.vscode: VSCode projects settings.
/node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
/src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.
/static: Static files like robots.txt or favicon.ico.
.editorconfig: EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
.eslintrc: This is a configuration file for Eslint. Find and fix problems in your JavaScript code
.gitignore: This file tells git which files it should not track / not maintain a version history for.
.prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.
gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.
gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.
LICENSE: Gatsby is licensed under the MIT license.
package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
README.md: A text file containing useful reference information about your project.
tsconfig.json: This is a configuration file for Typescript. TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
yarn.lock (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

🎓 Learning Gatsby

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

For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

As a static generated website, you can deploy it on Netlify, Github Page or ZEIT Now

6.2 KiB Raw Blame History Unescape Escape