https://github.com/sammarks/gatsby-template
My personal Gatsby template.
https://github.com/sammarks/gatsby-template
Last synced: 2 months ago
JSON representation
My personal Gatsby template.
- Host: GitHub
- URL: https://github.com/sammarks/gatsby-template
- Owner: sammarks
- License: mit
- Created: 2020-04-26T16:58:23.000Z (about 5 years ago)
- Default Branch: template
- Last Pushed: 2023-01-11T21:48:09.000Z (over 2 years ago)
- Last Synced: 2024-10-19T09:18:34.207Z (7 months ago)
- Language: TypeScript
- Size: 665 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
gatsby-starter-typescript-plus
> A starter kit for TypeScript-based Gatsby projects with sensible defaults.
This is a starter kit for [Gatsby.js](https://www.gatsbyjs.org/) websites written in TypeScript. It includes the bare essentials for you to get started (styling, Markdown parsing, minimal toolset).
## 🗒️ Features
- TypeScript
- ESLint (with custom ESLint rules)
- Markdown rendering with Remark
- Basic component structure
- Styling with [emotion](https://emotion.sh/)
## 🚀 Quick start
> A nodejs >= 6.0.0 setup with [yarn](https://yarnpkg.com/) is recommended.
1. **Create a Gatsby site.**
Install `gatsby-cli` package globally on your machine.
```bash
# using NPM
npm install -g gatsby-cli
# using YARN
yarn global add gatsby-cli
```
Use the `gatsby-cli` to create a new site and install its dependencies.
```bash
gatsby new project-name https://github.com/resir014/gatsby-starter-typescript-plus
```
2. **Start developing.**
Move to project's directory.
```bash
cd project-name/
```
Start your site.
```bash
# using npm
npm start
# using yarn
yarn start
```
Open source code using your favorite IDE/Text editor and navigate to `src/` directory, this is where your application live.
3. **Build your application for production.**
Once you're finished, you can make production build of your app using:
```bash
# using npm
npm run build
# using yarn
yarn build
```
4. **Deploy your app to Github pages!**
After building your application in step 3, you're ready to publish your app and go online!
```bash
# using npm
npm run deploy
# using yarn
yarn deploy
```
## ❤️ Credits
Built with [Gatsby](https://www.gatsbyjs.org/) - the blazing-fast static site generator for [React](https://facebook.github.io/react/).
## 💫 Deploy
[](https://app.netlify.com/start/deploy?repository=https://github.com/resir014/gatsby-starter-typescript-plus)