How To Install A Local Module Using NPM?

To install a local module using npm, it's important to understand how npm (Node Package Manager) works with local packages. npm allows you to manage and install various JavaScript packages and modules, whether they’re from a remote repository or locally on your system.

Installing a local module is particularly useful when you're developing a module or want to reuse custom packages across different projects without publishing them to the npm registry.

Why Do We Use Local Modules?

Local modules are essential when developing Node.js applications to include custom or in-progress functionality that isn't available on the npm registry. Using local modules allows developers to test and integrate their own code efficiently before publishing it or using it in different projects.

Installing local modules with NPM allows for better project management and modularity.

We have explained two methods to install local modules into an application. These methods will let you install a local module with no trouble.

Method 1: Install Local Modules Using npm-link 

 Step 1: Go to the local module directory ( package you want to install ) and enter this command.

npm link

Step 2: Go to the project directory where you want to install the local module and enter this command.  

npm link package-name

Example: Let the local-dir is the local directory and project-dir is the project directory and local_module is the local module package you want to install, first go to the local-dir and type npm link and next go to the project directory and type npm link <local_module> this will link your local module to your project.

Method 2: Install Local Module Using npm install

We need to provide <folder> argument to npm install, The argument should be the local folder where the package is present, Path is the location of the folder containing the package ( local_module ) you want to install

npm install /path

Example: Let the path where your local module stored is C:\Users\engineer\Desktop\package. Now go the project directory and type the command npm install C:\Users\engineer\Desktop\package

NOTE: Just provide the package folder name but not the package name, it will automatically
link it to your project.

How to Uninstall a Package Installed with an npm link?

To uninstall a module linked globally using npm link, you can use the npm unlink command. Run this command in your project directory to remove the link to the local module:

The following command can be used to remove the globally connected foo kit

npm rm --global foo

Using local modules in Node.js can streamline development and testing processes. By understanding how to link and install these modules, you can efficiently manage dependencies and integrate custom code into your projects. Whether you choose npm link for its flexibility or npm install for direct folder installation, both methods are used in Node.js development.