Skip to content

Bootstrap any Typescript project seamlessly!

License

Notifications You must be signed in to change notification settings

kibotrel/TS-Project-Template

Repository files navigation

Typescript Project Template

This includes a basic setup for a typescript project with all the scripts needed to develop, build, test and publish any package written in Typescript.

📦 What's in the box ?

Aside of the obvious Typescript support, this template includes the following features:

  • A strict Typescript configuration.
  • A targeted node version (specified in .nvmrc).
  • A Dependabot policy to keep dependencies up to date.
  • eslint with a strong configuration (mostly formatting and quality of life rules).
  • prettier to enforce a consistent code style.
  • vitest to run tests.
  • nodemon to speed up development.
  • commitlint to enforce a consistent commit message style.
  • husky to run scripts on git hooks.

🚀 Getting started

Once cloned, you can run the following commands:

  • pnpm install installs all the dependencies, setup husky and commitlint git hooks.
  • nvm use sets the node version to the one specified in .nvmrc (if you use nvm)
  • pnpm dev starts a nodemon process and gets you ready to develop.

ℹ️ pnpm is taken as an example here. You can use any package manager thanks to pm-exec.