my-starter-files

An npm package that copies starter files directly into the user's project folder on install.

How it works

When someone runs:

npm install my-starter-files

A postinstall script automatically copies everything inside the template/ folder into their project root.

• Files that already exist in the project are skipped (no overwrites).
• Subdirectory structures are preserved.

Setup — Adding your files

Place any files or folders you want distributed inside the template/ directory:

package/
├── package.json
├── install.js
├── index.js
├── template/          ← PUT YOUR FILES HERE
│   ├── index.html
│   ├── style.css
│   ├── app.js
│   └── assets/
│       └── logo.png
└── README.md

Everything inside template/ will be copied to the consumer's project root.

Publishing

1. Update the name field in package.json to your desired package name.
2. Add your files to the template/ folder.
3. Login and publish:

npm login
npm publish

Testing locally

You can test the package locally before publishing:

mkdir test-project
cd test-project
npm init -y
npm install ../package

The files from template/ should appear in test-project/.