Skip to content

This is a template project for kick-starting new projects using node with typescript without having to configure everything from scratch. It comes with several pre-configured development tools to help maintain code quality and facilitate development.

License

Notifications You must be signed in to change notification settings

LuccaRebelloToledo/node-ts-setup

Repository files navigation

Node Ts Setup

This is a template project for kick-starting new projects using node with typescript without having to configure everything from scratch. It comes with several pre-configured development tools to help maintain code quality and facilitate development.

Included Tools

  • Biome: Biome is a fast format for JavaScript, TypeScript, JSX, JSON, CSS, and GraphQL that achieves 97% compatibility with Prettier, saving time for both the developer and CI.
  • Husky: Used to set up git pre-commit hooks that can format your code and run tests before each commit.
  • Lint Staged: Used in conjunction with Husky, it allows only the files that are staged in git to be "linted" or formatted.
  • Git Commit Message Linter: A tool that can check the commit message to ensure it follows a commit message convention.
  • Jest: A testing framework.

How to Use

  1. Clone this repository
  2. Install dependencies with npm install
  3. Start developing!

Available Scripts

  • npm test: Runs tests with Jest.
  • npm run check: Runs linting and formatting with Biome.

Remember that Husky and lint-staged are set up to automatically run linting and formatting before each commit and git commit message linter before each push.

Contributing

Contributions are always welcome.

About

This is a template project for kick-starting new projects using node with typescript without having to configure everything from scratch. It comes with several pre-configured development tools to help maintain code quality and facilitate development.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published