开源必备,手把手教你做自己的开源项目--如何把代码放到npm上让别人下载

2022-10-28 18:52:26 浏览数 (1)

02

前言

好多小伙伴私信问我,说自己想做开源产品,想把自己的项目放到npm上,让别人去下载。

但不知道该如何去操作,首先还是非常地赞扬大家的开源精神的,帮助他人也等于帮助自己。其实要把自己的前端项目放到npm也不难,下面就介绍一下怎么把项目放到npm上让大家下载去使用。

02

什么是npm

看一下官方介绍:

NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种:

  • 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
  • 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
  • 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

当我们在电脑上安装完node之后,npm服务就安装完成了。这里不多介绍概念性的东西了,总之就是一个组织,上面有好多别人写好的代码供我们使用,当然,我们也可以把自己的代码放上去供别人使用。

如果对这还不了解,建议您先去网上查一下资料再来阅读下面的内容哦~~~

03

准备工作

如果我们想要把自己的代码放在npm,供别人下载使用,首先得先有源码呀 在开发 vue-admin-work的时候 ,在登录页面中有一个滑动验证组件,为了方便后期的项目使用,我就把它抽取成一个项目,开发完之后就放到了npm上了。以后我们在别的项目使用的时候就直接可以直接

代码语言:javascript复制
npm install vaw-verify --save

就好了。是不是很方便的,大大提高了重用性和维护性。 其次就是要在 npm 网站上注册一个账号

点击 sign up按钮一步步注册账号就好。

04

准备发布

这里假定您已经有一个项目要发布到 npm上,用 vscode打开项目(本人比较喜欢这个开发工具,其它开发工具也可以的哦)。打开底部终端:

然后输入如下命令:

代码语言:javascript复制
npm login

输入完以上命令,会让你输入你注册时用的 Username,Password,和 Email。如实填写就好。填写好所有信息,回车就好。登录成功会有如下提示:

代码语言:javascript复制
Logged in as xxxxx on https://registry.npmjs.org/.

到这里就说明登录成功,可以进行发布了。

然后再在终端里输入

代码语言:javascript复制
npm publish

等他发布完就ok啦~

05

添加忽略文件

和 githu中的 .gitignore 一样,我们在发布的时候,不想把所有的文件都发布,有些文件是不需要发布的,这个时候就需要基项目的根目录下面创建一个文件:.npmignore

打开添加要忽略的文件就行了。我的文件内容如下:

代码语言:javascript复制
.DS_Store
node_modules
/dist
/public
/src
/lib/*.map
babel.config.js
.gitignore
README.md
package-lock.json


# local env files
.env.local
.env.*.local

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

文件内容,根据个人的情况而定。

06

写在最后

到这里就完成了对项目的发布,当我们使用命令:

代码语言:javascript复制
npm install xxxx 

添加依赖的时候,项目就会从 npm 上下载下来放进项目的 node_modules目录中哦。

至此,我们就完成了 npm 的发布过程,大家一定要亲自动手试一下,其实就是几个命令而已。

成为开源大佬的第一步搞起来吧

0 人点赞