create-starboy
v1.0.7
Published
Lightning fast kickstarter for Node.js
Maintainers
Readme
create-starboy
A simple CLI to scaffold new projects using a predefined template. It also includes a development mode to auto-restart the server on file changes.
📦 What does it do?
This CLI tool helps you quickly bootstrap a new project from a template folder. It:
- Prompts you for a project name (or takes it from command line)
- Creates a new folder with that name (unless
.is passed to use current dir) - Copies template files into the folder
- Replaces
{{projectName}}placeholders inREADME.mdandpackage.json - Supports a
devcommand to run a file watcher and auto-restart your server
🛠️ Installation (Globally)
npm install -g create-starboyOr using pnpm:
pnpm add -g create-starboy🚀 Usage
1. Create a new project
npm create starboyor with pnpm:
pnpm create starboyThen follow the prompt to name your project.
2. Create a project in the current folder
npm create starboy .or
pnpm create starboy .This will use the current working directory instead of making a new one.
3. Start the dev mode
Once your project is created, go into the folder and run:
pnpm devOr via npm:
npm run devThis starts the dev.js script, which:
- Watches your project files (ignores
node_modules,.git,dist) - Restarts the server (at
src/index.js) whenever a file changes
📌 Notes
- If the target folder already exists, it will exit with an error.
- Automatically adds progress bar while creating files.
- Works smoothly with both
npmandpnpm.
🔗 GitHub
Check out the source code here: https://github.com/fazalkadivar21/starboy
