A TypeScript starter for Gatsby. No plugins and styling. Exactly the necessary to start 🔥
No plugins installed, great for advanced users.
- 📏 ESLint — Pluggable JavaScript linter
- 💖 Prettier - Opinionated Code Formatter
- 🐶 Husky — Use git hooks with ease
- 📄 Commitizen - Conventional commit messages CLI
- 🐐 Tests - Jest and Testing Library
- 🚓 Commitlint - Lint commit messages
- 🖌 Renovate - Dependency update tool
- 🚫 lint-staged - Run linters against staged git files
- 👷 PR Workflow - Run Type Check & Linters on pull requests
- 🗂 Root import - Import folders and files using the
@
prefix.
The best way to start with this template is using the Gatsby CLI.
npx gatsby new starter-ts https://github.com/jpedroschmitz/gatsby-starter-ts
If you prefer you can clone this repository and run the following commands inside the project folder:
By default, this starter uses Yarn, but this choice is yours. If you'd like to switch to npm, delete the
yarn.lock
file, install the dependencies withnpm install
, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands.
yarn
;yarn start
;
To view the project you can open http://localhost:8000
.
- Fork this repository;
- Create your branch:
git checkout -b my-new-feature
; - Commit your changes:
git commit -m 'Add some feature'
; - Push to the branch:
git push origin my-new-feature
.
After your pull request is merged, you can safely delete your branch.
This project is licensed under the MIT License - see the LICENSE.md file for more information.