TypeScript Boilerplate

Quick start

Make sure Node.js, Yarn and Git are installed in your system before starting.

1. Clone or download the repo (Click on Use this template if you want to create your own repo)
2. Open package.json in your editor and change the values of: name, description, author, repository, keywords
3. Run yarn install

You are ready to go. Edit src/index.ts and run yarn start to execute it.

Scripts

yarn start

Starts the app with hot reloading.

The app will refresh every time a file is changed in the src folder.

yarn build

Builds the app in the build folder.

yarn build:start

Builds the app in the build folder and starts it.

yarn test

Runs the tests.

yarn prettier

Runs Prettier in the src folder fixing all fixable issues.

yarn lint

Runs ESLint in the src folder fixing all fixable issues.

yarn release

Generates the changelog and increase the version from commit messages.

The most common convention for commit messages is the Angular convention which is detailed here.

Tools

Jest

Testing framework.

Prettier

Code formatter.

ESLint

Code syntax analyzer.

Husky

Allows to run scripts on git hooks

Standard Version

Automatic changelog generation powered by Conventional Commits.

References

How to Setup a TypeScript + Node.js Project

TypeScript Deep Dive