build-node-starter v1.0.0

Build Node Starter - CLI Tool

Overview

Build Node Starter is a command-line tool that generates a Node.js starter project, which is TypeScript ready. It simplifies project setup by scaffolding a basic Node.js structure, optionally with Express.js.

Note: Currently you will be needing a node version 23.6.0 or newer to run the newly generated template smoothly because this starter template contains typescript files.

Features

• Generates a Node.js starter project with TypeScript capabilities.
• Simple and easy to use.
• Optional Express.js integration.
• Fully interactive CLI with user prompts.

Installation

Run the command directly using npx (without any node package installation):

npx build-node-starter node-project

Usage

Basic Usage

To create a new Node.js project, run:

npx build-node-starter node-project

Note: Above command will create a node project directory "node-project" with the starter template inside it. You can simply rename your result project by editing the "node-project" argument in the command.

Using Express.js

If you want an Express.js template, use the --express flag after the project directory argument:

npx build-node-starter my-app --express

Alternatively, the CLI will prompt you to choose Express.js during the normal setup.

Next Steps

Once the project is created, follow these steps:

cd node-project
npm install
npm run dev

Project Structure

The generated project will have the following structure:

node-project/
│-- .gitignore
│-- eslint.config.js
│-- index.ts (or server.ts)
│-- package-lock.json
│-- package.json
│-- tsconfig.json

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to submit a pull request to the GitHub repository: build-node-starter.

Author

Mohd Saud
Email: mohdsaud1523@gmail.com