Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 739 Bytes

README.md

File metadata and controls

40 lines (29 loc) · 739 Bytes

ts-template

This is template project with typescript.

This project is a good starting point if you want to create and publish npm module.

This project includes

  • Typescript
  • ts-node-dev setup for development
  • jest setup for unit test cases with coverage report
  • eslint setup
  • pretier setup
  • commitlint setup
  • Github actions for CI and npm publish

How to

  • Get started

      git clone <repo_url> <folder>
      cd folder
      npm install
    
  • Run code in dev mode (watch your changes, and if changed re run automatically)

      npm start
    
  • Run test cases

      npm test
    
  • Build your code

      npm run build
    

Todo

  • How To guide
  • github actions
  • fork this for api with docker setup