README
generator-node-tsnext
Generator for developing in TypeScript Next
To scaffold a Node.js module or any project written in TypeScript.
Table of contents
Pre-requisites
Please make sure that you have the following dependencies installed and setup correctly:-
- Node.js >=
10.18.1 - NPM >=
6.13.4 - TypeScript >=
3.8.3 - TSLint >=
6.1.0 - TSLint extension for your favorite text editor
Installation
NPM
First, install generator-node-tsnext using NPM (we assume you have pre-installed Node.js).
# Install globally with NPM
$ npm install -g yo generator-node-tsnext
Then generate your new project:
# Create a new directory if you haven't already.
# Then change to that new directory.
$ mkdir my-app && cd my-app
# Init
$ yo node-tsnext
NPX
NPX comes in a package as of Node.js v8.9.0. This means that you can run any CLI written in Node.js without globally installing it.
# Create a new directory if you haven't already.
# Then change to that new directory.
$ mkdir my-app && cd my-app
# Install packages with NPX and execute the CLI with this one-liner
$ npx -p yo -p generator-node-tsnext -- yo node-tsnext
Testing
Bring your own testing library/ framework based on your use case. But, here are a few to recommend if you haven't already had one:
Getting To Know Yeoman
- Yeoman has a heart of gold.
- Yeoman is a person with feelings and opinions, but is very easy to work with.
- Yeoman can be too opinionated at times but is easily convinced not to be.
- Feel free to learn more about Yeoman.
Contributing
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
License
MIT License © Rong Sen Ng