VELAM npm Package Storage Registry (PSR)

The VELAM npm Package Storage Registry (PSR) is the organization’s centralized repository for storing and managing essential npm package .tgz files. It enables the team to consistently use specific versions of packages directly from GitHub, ensuring seamless and controlled dependency management across all projects.

---

How It Works

1. Admin Prepares Packages:

• Download and store .tgz files for specific package versions in this GitHub repository.

2. Team Installs Directly from GitHub:

• Use GitHub raw URLs in package.json to ensure npm install fetches the correct package version.

Reference Example:

{
  "dependencies": {
    "react": "https://raw.githubusercontent.com/velamai/package-storage/main/react-17.0.1.tgz"
  }
}

---

Steps Based on Role:

For Administrators

1. Package Preparation:

   • Identify the required npm package versions in consultation with the Development Lead and Project Manager (PM).
   • Open this repository locally or in a cloud code-space with terminal access.
   • Run the following command to generate a .tgz file:

     npm pack [email protected]

   • This will generate a .tgz file like react-17.0.1.tgz.

2. Commit and Push the Package:

   • Stage the new package:

     git add .

   • Commit the changes using the standard commit message format:

     git commit -m "npm: [email protected] add"

   • Push the changes to the repository:

     git push

---

For the Development Team

1. Modify package.json:

   • Use the following format to reference packages from the PSR:

     {
       "dependencies": {
         "react": "https://raw.githubusercontent.com/velamai/package-storage/main/react-17.0.1.tgz"
       }
     }

2. Install Dependencies:

   • Run npm install as usual to fetch packages from the GitHub repository:

     npm install

---

Benefits of Using VELAM PSR

• Version Consistency: Ensures all team members use the exact same package versions.
• Centralized Control: Allows the admin to manage and maintain approved package versions.
• Seamless Team Integration: No need for extra configuration or scoped package naming.

---

By following this process, the entire development team will maintain a unified package management system, reducing issues related to version mismatches and ensuring project stability.