/HYBwebsite

Primary LanguageTypeScriptMIT LicenseMIT

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.

Docker Setup

This allows you to run a dev and build environment from within a Docker container. Hopefully helps with the "it works[/doesn't work] on my machine problems" by creating a consistent environment. This requires installing Docker for Desktop and having it running.

  1. Clone this repo and move into it via a terminal: git clone <url> and cd <file path to base of the repo>
  2. Launch the container and map files/port: docker run -it --rm -v $PWD:/site -p 8000:8000 -w /site node:16.11 bash
  3. Install dependencies: yarn
  4. Start a dev server: yarn start --host 0.0.0.0

🤝 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