Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pratikmane0112/publish-npm-package
https://github.com/pratikmane0112/publish-npm-package
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pratikmane0112/publish-npm-package
- Owner: PratikMane0112
- Created: 2024-07-27T10:27:23.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-29T15:56:49.000Z (about 2 months ago)
- Last Synced: 2024-11-29T16:37:38.119Z (about 2 months ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# How to Publish Your First npm Package
Publishing your first npm package can be an exciting and rewarding experience. This guide will walk you through the process step by step.
## Step 1: Set Up Your Development Environment
Before you start, make sure you have Node.js and npm installed on your machine. You can download and install them from [nodejs.org](https://nodejs.org/).
Verify your installation by running the following commands in your terminal:
```bash
node -v
npm -v
```
## Step 2: Create a New Project
Create a new directory for your project and navigate into it:
```bash
mkdir my-first-npm-package
cd my-first-npm-package
```
Initialize a new npm project:
```bash
npm init
```
This command will prompt you to fill in some details about your package. You can press Enter to accept the default values or provide your own.
## Step 3: Write Your Package Code
Create a new file named index.js and write your package code. You can create your own logic and ideas for the functionlities & features which your package will provide. For your simplicity & making it simple, let's create a simple package that adds two numbers for an example :
```bash
function add(a, b) {
return a + b;
}
module.exports = add;
```
## Step 4: Add a README File
Create a README.md file to provide information about your package. This file render as a brief info/description about your package on npm website, Here is a basic example:
```bash
# My First npm Package
This is a simple package that adds two numbers.
## Installation
npm install my-first-npm-package
## Usage
const add = require('my-first-npm-package');
console.log(add(2, 3)); // Outputs: 5
##License
This project is licensed under the MIT License.// Add a License for npm package available on
// github.
```
## Step 5: Add a `.gitignore` File
Create a `.gitignore` file to exclude `node_modules` and other unnecessary files from your git repository:
```gitignore
node_modules/
```
## Step 6: Publish Your Package
Before publishing, you need to create an account on npmjs.com. Once you have an account, log in using the following command:
```bash
npm login
```
Follow the prompts to enter your username, password, and email.
```bash
npm publish
```
If everything is set up correctly, your package will be published to the npm registry and available for others to install.
## Step 7: Update Your Package
If you make changes to your package, you need to update the version number in package.json before publishing again. For example, to update to version 1.0.1:
```bash
{
"name": "my-first-npm-package",
"version": "1.0.1",
...
}
```
Then, publish the updated package:
```
npm publish
```
## Conclusion
Congratulations! You've published your first npm package. Now you can share your code with the world and contribute to the open-source community.