TypeScript Node Boilerplate π
- Minimalistic project template to jump start a Node.js back-end application in TypeScript
- Need Express.js too? Check out typescript-express-boilerplate instead.
Pre-configured tools βοΈ
- ESLint
- Prettier
- Jest
- Nodemon
- Visual Studio Code's Debuggers
Getting Started
Prerequisite
- Node v20.x (LTS) or later
There are many ways to use the template:
A. Use as a repository template
- To start, just click the Use template link (or the green button).
- Start adding your code in the
src
and unit tests in the __tests__
directories.
B. Clone repository
To clone the repository, use the following commands:
git clone https://github.com/anhtungbui/typescript-node-boilerplate
cd typescript-node-boilerplate
npm install
Authors
Anh Tung Bui @ abui.dev
License
This project is licensed under the MIT License - see the LICENSE file for details
Acknowledgments
- https://www.youtube.com/watch?v=H91aqUHn8sE
- https://blog.logrocket.com/how-to-set-up-node-typescript-express/
- https://khalilstemmler.com/blogs/typescript/eslint-for-typescript/
- https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file
- https://gist.github.com/DomPizzie/7a5ff55ffa9081f2de27c315f5018afc
- https://github.com/jsynowiec/node-typescript-boilerplate