Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Gatsby and TypeScript

PRs welcome! License Follow @jpedroschmitz


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.

πŸš€ Getting started

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 with npm install, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands.

  1. yarn;
  2. yarn start;

To view the project you can open http://localhost:8000.

🀝 Contributing

  1. Fork this repository;
  2. Create your branch: git checkout -b my-new-feature;
  3. Commit your changes: git commit -m 'Add some feature';
  4. Push to the branch: git push origin my-new-feature.

After your pull request is merged, you can safely delete your branch.

πŸ“ License

This project is licensed under the MIT License - see the LICENSE.md file for more information.


Made with β™₯ by JoΓ£o Pedro Schmitz

About

TypeScript starter for Gatsby. No plugins and styling. Exactly the necessary to start. Ready for Gatsby v4 πŸ”₯

Topics

Resources

License