https://github.com/sfmohassel/ts-node-template

A simple ts-node template with prettier, nvmrc and eslint
https://github.com/sfmohassel/ts-node-template

boilerpla boilerplate-template nodejs nodemon ts-node typescript

Last synced: 10 months ago
JSON representation

A simple ts-node template with prettier, nvmrc and eslint

Host: GitHub
URL: https://github.com/sfmohassel/ts-node-template
Owner: sfmohassel
Created: 2022-07-12T20:54:24.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-08-13T20:17:01.000Z (over 3 years ago)
Last Synced: 2025-02-17T10:38:03.819Z (10 months ago)
Topics: boilerpla, boilerplate-template, nodejs, nodemon, ts-node, typescript
Language: JavaScript
Homepage: https://sfmohassel.medium.com/typescript-node-get-started-project-template-ad0ba9a7a885
Size: 106 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

README

# ts-node-template

![Screenshot 2022-07-18 234510](https://user-images.githubusercontent.com/20520614/179624179-9867b5d9-fd28-4304-8042-c99a5d8d953c.png)

A simple npx template for typescript node applications with prettier, nvmrc, eslint and nodemon.

## Features

- Typescript
- Eslint
- Prettier formatting
- Using NVM to fix node version to latest LTS version
- Example .gitignore
- Live reloading with nodemon

## Publish

- Update package.json version
- npm publish --registry https://registry.npmjs.org --access=public

## Usage

```bash
# make sure have node version > 16.x
# cd into your repository root
npm init -y
npx @saeidjoker/ts-node-template@latest
```

After that, you can test your app with this command
```bash
npm run start:dev
```

This will print `hi` on the console. You can change the contents of `src/index.ts` and save the file and the app will cold-reload :-)

Enjoy!