https://github.com/tib0/typescript-node-module-template

Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.
https://github.com/tib0/typescript-node-module-template

eslint jest nodejs pnpm tsup typescript vscode

Last synced: 3 days ago
JSON representation

Typescript Node Module Template (tnmt) by Tib0, featuring jest, tsup, vscode, pnpm, eslint and prettier.

• Host: GitHub
• URL: https://github.com/tib0/typescript-node-module-template
• Owner: tib0
• License: mit
• Created: 2024-04-27T14:46:50.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-14T11:37:45.000Z (6 months ago)
• Last Synced: 2024-10-11T18:17:13.105Z (28 days ago)
• Topics: eslint, jest, nodejs, pnpm, tsup, typescript, vscode
• Language: TypeScript
• Homepage:
• Size: 295 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![logo](./.github/tnmt-logo.png)

Sample node module template by Tib0. Shipped with:

- [x] Github's actions

- [x] VSCode config

- [x] Node config

- [x] TypeScript

- [x] Prettier

- [x] Eslint

- [x] Pnpm

- [x] Tsup

- [x] Jest

# USE

Follow these steps to make it yours :

1. Clone the repository :

```sh

git clone https://github.com/tib0/typescript-node-module-template.git

```

2. Update package.json entries (author, name...)

```sh

code typescript-node-module-template\package.json

```

3. Rename folder `typescript-node-module-template` to whatever suit your needs.

```sh

mv typescript-node-module-template\ \

```

4. Remove git history :

```sh

rm -rf .git && git init && git add . && git commit -m "Initial commit"

```

5. Push :

```sh

git push

```