This project is a template for TypeScript projects to make the setup easier.
-
Make sure you have the prerequisites installed. You need node.js and yarn.
-
Clone the repository:
HTTPS:
git clone https://github.com/TimJentzsch/ts-project-template.git
SSH:
git clone [email protected]:TimJentzsch/ts-project-template.git
-
Remove the
.git
folder and start a new git repository:git init
-
Install the dependencies:
yarn install
-
Adjust the metadata in
package.json
andLICENSE
.
This project configures the following tools:
- yarn (package management)
- git (version control)
- TypeScript
- eslint (linting)
- prettier (formatting)
- jest (testing)
- husky (pre-commit/push hooks)
- winston (logging)
yarn build
: Build the TypeScript files (todist
)yarn start
: Start the main TypeScript fileyarn lint
: Run eslintyarn format
: Auto-format all source filesyarn test
: Run all testsyarn coverage
: Run all tests with coverage