Typescript Starter

I promise it won't hurt you. Just use it.

Included Packages

• dotenv: ^16.4.5
• rotating-file-stream: ^3.2.3
• tslog: ^4.9.3
• yargs: ^17.7.2

Included Dev Packages

• @types/node: ^20.14.9
• @types/yargs: ^17.0.32
• @typescript-eslint/eslint-plugin: ^7.15.0
• @typescript-eslint/parser: ^7.15.0
• eslint: ^8.57.0
• eslint-config-airbnb-base: ^15.0.0
• eslint-config-airbnb-typescript: ^18.0.0
• eslint-config-prettier: ^9.1.0
• eslint-plugin-import: ^2.29.1
• eslint-plugin-prettier: ^5.1.3
• npm-run-all: ^4.1.5
• prettier: ^3.3.2
• rimraf: ^5.0.7
• ts-node-dev: ^2.0.0
• typescript: ^5.5.3

Recommended Extensions

• Extension named: prettier (esbenp.prettier-vscode)
• Extension named: eslint (dbaeumer.vscode-eslint)

Scripts

Start the project

You must build the project in order to start

npm run start

Start the project in development environment

npm run dev

Clean the compiled code and build

npm run build

Don't clean the compiled code and build

npm run build:tsc

Clean the compiled code

npm run clean-dist

Format the code

npm run format

Guides

Setup Guide

1. Install dependencies by using this script
2. Rename file .env.development example to .env.development
3. Start by using this script
4. Code somethings...

Production Usage

1. Build by using this script
2. Rename file .env example to .env
3. Start by using this script

License

This project licensed with MIT license