1 | # typescript-node-scripts
|
2 | ![](https://github.com/liangchunn/typescript-node-scripts/workflows/Node%20CI/badge.svg) [![npm](https://img.shields.io/npm/v/typescript-node-scripts.svg)](https://www.npmjs.com/package/typescript-node-scripts) [![npm](https://img.shields.io/npm/dt/typescript-node-scripts.svg)](https://www.npmjs.com/package/typescript-node-scripts) [![install size](https://packagephobia.now.sh/badge?p=typescript-node-scripts)](https://packagephobia.now.sh/result?p=typescript-node-scripts) [![Known Vulnerabilities](https://snyk.io/test/github/liangchunn/typescript-node-scripts/badge.svg)](https://snyk.io/test/github/liangchunn/typescript-node-scripts)
|
3 |
|
4 |
|
5 |
|
6 | Create Node.js applications based on TypeScript with zero-configuration.
|
7 |
|
8 | <p align="center">
|
9 | <img
|
10 | width="600" src="https://cdn.rawgit.com/liangchunn/typescript-node-scripts/12e1600/.resources/term.svg"/>
|
11 | </p>
|
12 |
|
13 | Inspired by `create-react-app` and Dan Abramov's [The Melting Pot of JavaScript](https://increment.com/development/the-melting-pot-of-javascript/).
|
14 |
|
15 | - Supports testing, building, and development in watch mode
|
16 | - Supports custom TypeScript path mappings, aka `compilerOptions.path`
|
17 |
|
18 | ## Quick Start Guide
|
19 |
|
20 | ```sh
|
21 | npx typescript-node-scripts create <appName>
|
22 | cd <appName>
|
23 | yarn start
|
24 | ```
|
25 |
|
26 | ## Requirements
|
27 |
|
28 | - node `>=8.0.0`
|
29 | - `process.platform !== 'win32'`
|
30 |
|
31 | ## Documentation
|
32 |
|
33 | Access the documentation here: https://liangchunn.github.io/typescript-node-scripts
|