https://github.com/anhtungbui/typescript-node-boilerplate
Minimalistic project template to jump start a Node.js back-end application in TypeScript 🚀 ESLint, Prettier, Jest, Nodemon, Debuggers pre-configured ⚙️
https://github.com/anhtungbui/typescript-node-boilerplate
eslint nodejs nodemon prettier typescript vscode
Last synced: 5 months ago
JSON representation
Minimalistic project template to jump start a Node.js back-end application in TypeScript 🚀 ESLint, Prettier, Jest, Nodemon, Debuggers pre-configured ⚙️
- Host: GitHub
- URL: https://github.com/anhtungbui/typescript-node-boilerplate
- Owner: anhtungbui
- License: mit
- Created: 2024-08-10T15:04:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-11T12:31:22.000Z (almost 2 years ago)
- Last Synced: 2025-05-20T21:38:07.837Z (about 1 year ago)
- Topics: eslint, nodejs, nodemon, prettier, typescript, vscode
- Language: TypeScript
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/anhtungbui/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:
```bash
git clone https://github.com/anhtungbui/typescript-node-boilerplate
cd typescript-node-boilerplate
npm install
```
## Authors
Anh Tung Bui @ [abui.dev](https://abui.dev)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
1. https://www.youtube.com/watch?v=H91aqUHn8sE
2. https://blog.logrocket.com/how-to-set-up-node-typescript-express/
3. https://khalilstemmler.com/blogs/typescript/eslint-for-typescript/
4. https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file
5. https://gist.github.com/DomPizzie/7a5ff55ffa9081f2de27c315f5018afc
6. https://github.com/jsynowiec/node-typescript-boilerplate