npm是一个包管理器,被广泛用于Nodejs JavaScript,用于安装各种包、依赖和模块。开发人员可以使用它来获得一个中央包存储库,以便用于他们的项目,从而加快应用程序的构建过程。
虽然大多数Nodejs项目所需的流行软件包都已发布到NPM注册表中。但是,某些软件包可能无法使用NPM注册表安装,需要直接从它们的GitHub存储库中下载和安装。使用GitHub的另一个原因是,您可能正在寻找安装NPM注册表中没有的特定版本的软件包。
无论直接从GitHub安装npm软件包的原因是什么,本文将介绍如何进行操作。
步骤1:安装Git
首先,我们需要在使用NPM的Linux、Windows或macOS上安装Git,以便它可以使用它来获取一个包的Git仓库。
对于Linux:
Debian/Ubuntu
sudo apt install git
基于RPM的Linux,如RHEL。
sudo dnf install git -y
对于Windows 10/11,您可以查看此链接文章以安装Git。
步骤2:在GitHub上找到包
直接从GitHub安装NPM包的第一步是确定您要从GitHub获取的包的名称。
这可以通过手动访问GitHub网站并搜索来完成。或者,您可以通过谷歌搜索该包以获取其GitHub仓库的URL。简而言之,首先,我们需要一个指向包仓库的链接。一旦您拥有了这个链接,就可以进入下一步。
步骤3:复制Git URL
在GitHub上找到您的包的仓库后,只需复制它的URL。您可以通过单击位于右上角的标有“Code”的绿色按钮轻松完成此操作。单击该按钮后,从弹出菜单中复制“Clone”部分下提供的HTTPS URL。
例如:假设我想要从GitHub安装一个搜索索引Nodejs库。那么,我将访问它的页面,然后复制它的git URL
步骤4:使用NPM安装包
一旦您拥有Git URL,就可以使用常规的npm install
命令在您的系统上获取GitHub的NPM包。首先,在命令终端或命令提示符中导航到要安装包的项目目录,然后使用以下命令语法获取它。
语法:
npm install link-to-GitHub-repository
例如:
npm install https://github.com/fergiemcdowall/search-index.git
请确保将link-to-GitHub-repository
替换为您在上一步中复制的实际Git URL。
安装完成后,您可以在项目中开始使用该包。
步骤五:验证安装
执行命令后,NPM包管理器将会下载并安装你所需要的GitHub NPM包到你的系统中。
为了验证是否成功安装了你需要的包,可以运行以下命令:
npm ls
这将列出安装在你的项目中的所有Node.js包,包括你从GitHub获得的包。
此外,你也可以使用以下命令检查已安装的包的版本:
npm list <package-name>
将``替换为你从GitHub安装的包的名称。
如果该包被列出,并且版本号与你打算安装的版本号相匹配,则表示安装成功。
你也可以通过将包导入到代码中并运行它来验证该包是否已正确集成到你的项目中。如果包按预期功能,则表示安装成功。
恭喜你!你已经成功使用NPM从GitHub安装了一个Node.js包。