https://github.com/aerilym/typescript-template
This is a template for TypeScript projects using Node. It uses TypeScript for strict typing and compiling into JavaScript and Nodemon to automatically refresh the build when changes are made. It's set up to use ESLint for linting and Prettier for formatting.
https://github.com/aerilym/typescript-template
linter template typescipt typescript-template
Last synced: 12 months ago
JSON representation
This is a template for TypeScript projects using Node. It uses TypeScript for strict typing and compiling into JavaScript and Nodemon to automatically refresh the build when changes are made. It's set up to use ESLint for linting and Prettier for formatting.
- Host: GitHub
- URL: https://github.com/aerilym/typescript-template
- Owner: Aerilym
- Created: 2022-09-10T04:40:59.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-10T04:41:02.000Z (almost 4 years ago)
- Last Synced: 2024-12-31T20:27:11.342Z (over 1 year ago)
- Topics: linter, template, typescipt, typescript-template
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript Template for Node
This is a template for TypeScript projects using [Node](https://nodejs.org/). It uses [TypeScript](https://www.typescriptlang.org/) for strict typing and compiling into JavaScript and [Nodemon](https://nodemon.io/) to automatically refresh the build when changes are made. It's set up to use [ESLint](https://eslint.org/) for linting and [Prettier](https://prettier.io/) for formatting.
## Getting Started
To get started, clone this repository and run `yarn install` or `npm install` to install the dependencies.
The information in `package.json` should be changed to reflect the details of your project.
## Scripts
The following scripts are available:
- `yarn build` or `npm run build` - Compiles the TypeScript files into JavaScript.
- `yarn start` or `npm run start` - Runs the compiled JavaScript files.
- `yarn dev` or `npm run dev` - Runs the TypeScript files directly using Nodemon.
- `yarn lint` or `npm run lint` - Runs ESLint on the TypeScript files.
- `yarn format` or `npm run format` - Runs Prettier on the TypeScript files.
- `yarn release:` or `npm run release:` - Formats and build the project then bumps the version number and creates a Git tag.