🚀 Node.js – Publish a Package to NPM

Publishing your own package on NPM allows developers around the world to install and use it with:

Follow these steps:

✅ 1. Create Your Project Folder

Example:

Go inside it:

✅ 2. Initialize package.json

Run:

Or fast version:

This creates a basic package.json.

✅ 3. Create Your Main File

Create index.js:

✅ 4. Update package.json (Important)

Open package.json and add:

⚠ Requirements for package name:

• must be unique

• must be lowercase

• cannot contain spaces

• can use hyphens -

To check availability:

✅ 5. Login to NPM

If you don’t have an account → create:

👉 https://www.npmjs.com/signup

Login via terminal:

It will ask:

• username

• password

• email

✅ 6. Publish the Package

Run:

🎉 Congratulations! Your package is now live.

Users can install it:

🔒 7. Publishing Scoped Packages (Optional)

If your username is vipul, scoped package example:

Publish:

🔁 8. Updating a Published Package

You must change the version each time you publish again:

Inside package.json:

Then:

❌ 9. Unpublishing a Package

Within 24 hours:

⚠ Be careful: Unpublishing affects users.

📦 Folder Structure Example

⭐ Optional (but Highly Recommended)

Add README.md

This appears on your NPM package page.

Add .gitignore

Especially for node_modules:

🎯 Summary