https://github.com/alabsi91/nodejs-cli-typescript-nsis-template

Node.js CLI template
https://github.com/alabsi91/nodejs-cli-typescript-nsis-template

boilerplate cli installer nodejs nsis-installer template typescript

Last synced: 3 days ago
JSON representation

Node.js CLI template

• Host: GitHub
• URL: https://github.com/alabsi91/nodejs-cli-typescript-nsis-template
• Owner: alabsi91
• Created: 2022-07-29T13:54:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-16T14:45:09.000Z (3 months ago)
• Last Synced: 2024-08-17T14:07:40.306Z (3 months ago)
• Topics: boilerplate, cli, installer, nodejs, nsis-installer, template, typescript
• Language: TypeScript
• Homepage:
• Size: 146 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node.js CLI template

- ✅ Typescript.

- ✅ eslint.

- ✅ esbuild.

- ✅ prettier.

- ✅ Inquirer.

- ✅ Chalk.

- ✅ Gradient-string

- ✅ node-fetch

- ✅ NSIS installer

- ✅ built-in:

  - Arguments parser.

  - Help message generator.

  - Logger.

  - Spinner (loading).

  - and more...

## Scripts

### `start:dev`

- Start the project in development mode **( Hot Reload )**.

### `build:js`

- Build typescript files into javascript files.

### `serve:build`

- Start the project from the build folder.

### `build:bundle`

- Bundle the project and its dependencies into a single minified file.

### `serve:bundle`

- Start the project from the bundle folder.

### `build:executable`

- Build the project into an executable file.

- Supports Windows, Linux and macOS.

- Nodejs version must be `20` or higher.

### `build:installer`

> ⚠️ For Windows only

- Creates an NSIS installer.

## Usage

- First clone the project.

```console

git clone https://github.com/alabsi91/nodejs-cli-typescript-nsis-template.git

```

- Then go to the project folder and install the dependencies.

```console

npm install

```