README.md

Boilerplate starter for simple Typescript tasks (with testing by jest) by Localhost Academy

by Localhost Academy

boilerplate includes:

• typescript for better code writting
• jest with typescript for comfortable testing
• nodemon for real time script reload

how to install global deps (if you don't already have them):

npm install -g typescript nodemon jest ts-jest esbuild npx concurrently
// or 
yarn global add typescript nodemon jest ts-jest esbuild npx concurrently

how to install deps:

npm install 
// or 
yarn

boilerplate structure:

// src/* - developers files
// build/* - production files

// src/common/*.ts - parts shared in script like utils or helpers
// src/common/__test__/*.test.ts - example of test for shared part
// src/task/*.ts - main part of script
// src/data/*.json - hardcoded data dir
// src/typings/index.d.ts - custom shared types

how to start developing:

npm run start
// or 
yarn start

how to start testing:

npm run test
// or 
yarn test