Template-for-Typescript-Projects

This is a template repository for kickstarting the development of Typescript projects

Usage

Dependencies

npm install

Run the project (suitable for both Dev and Production deployments)

npm run build && npm run start

Run Unit Tests using Mocha and DepCruise

npm run test

Code formatting with Prettier

Check code format

npm run format:check

Format code

npm run format:write

Code linting with ESLINT

Check for code errors

npm run lint:check

Correct code from errors

npm run lint:fix

Git Hooks

The template comprises also two Git hooks, if at least one of these fails, a Git commit is not produced:

• pre-commit hook verifies that tests, code format and linter checks complete successfully before applying the commit;
• commit-msg ensures that the commit message follows the Conventional Commit specification.

CI/CD

Navigate to the Let's Stream It report to see the details of the CI/CD pipeline: Report link.