node-common-dock-ab2
v0.2.8
Published
Scaffold boiler-plate from embedded templates/server
Readme
Node Common Dock
A CLI tool to scaffold a standard Node.js project structure.
Features
- Generates a robust Node.js project structure.
- Merges with existing
package.jsonif present. - Interactive CLI prompts.
Installation
You can install this package globally or use it with npx.
npm install -g node-common-dock-ab2Usage
Quick Start (Recommended)
Run the following command in your terminal:
npx node-common-dock-ab2This will prompt you for the target directory (default is current directory) and scaffold the project.
Manual Installation
Create a new directory and initialize it:
mkdir my-project cd my-project npm init -yInstall the package:
npm install node-common-dock-ab2Run the scaffold command:
npx node-common-dock-ab2
Options
-d, --dir <directory>: Specify the target directory.--overwrite: Overwrite existing files without asking (use with caution).
Project Structure
The generated project includes:
- src/: Source code (controllers, models, routes, etc.)
- .env: Environment variables
- package.json: Pre-configured scripts and dependencies
License
MIT
