- Run
$ git clone https://github.com/KumarAbhirup/typescript-boilerplate <PROJECT_NAME>
$ cd <PROJECT_NAME>
$ npm i
$ npm run dev
In VSCode
-
Install ESLint and Prettier VSCode extensions.
-
Done! Now you have live linting and autofixing setup!
In Any other IDE
-
Run
npm run lint
to check for linting errors. -
Run
npm run lint:fix
to fix the linting errors.
- All your TypeScript code should lie in the
./src
directory. - The entrypoint is
index.ts
. Never delete theindex.ts
file unless you know what you are doing is right. - The code is compiled in the
./dist
folder and the real Node.js entrypoint is./dist/index.js
. - To customize the linter, use
.eslintrc
and.prettierrc
file. Learn more
MIT - Source code by Kumar Abhirup