https://github.com/alanbsmith/typescript-node-starter
a simple starter for using TypeScript with Node
https://github.com/alanbsmith/typescript-node-starter
Last synced: about 1 year ago
JSON representation
a simple starter for using TypeScript with Node
- Host: GitHub
- URL: https://github.com/alanbsmith/typescript-node-starter
- Owner: alanbsmith
- License: mit
- Created: 2021-08-08T03:22:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-16T04:51:10.000Z (almost 5 years ago)
- Last Synced: 2025-03-28T18:52:16.754Z (over 1 year ago)
- Language: JavaScript
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TypeScript Node Starter
## Overview
This is a simple starter for using TypeScript with Node. It has a handful of helpful tools to
improve development workflow and maintenance.
## Installation
You'll likely want to fork this repo on GitHub and clone instead of cloning directly. If that's the
case, run:
```sh
git clone https://github.com/[USERNAME]/typescript-node-starter
cd typescript-node-starter
npm install
```
## Development
### Workflow
```sh
npm run start:dev
```
### Testing
Run tests once:
```sh
npm test
```
Watch test:
```sh
npm run test:watch
```
Watch all tests:
```sh
npm run test:watchAll
```
## Contributing
All of the following are appreciated:
- [Open an issue](https://github.com/alanbsmith/typescript-node-starter/issues)
- [Submit a pull request](https://github.com/alanbsmith/typescript-node-starter/compare)
Please be sure to follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
## License
[MIT](./LICENSE)