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

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

前言

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

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


什么是npm

看一下官方介绍:

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

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

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

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


准备工作

如果我们想要把自己的代码放在npm,供别人下载使用,首先得先有源码呀

在开发 vue-admin-work的时候 ,在登录页面中有一个滑动验证组件,为了方便后期的项目使用,我就把它抽取成一个项目,开发完之后就放到了npm上了。以后我们在别的项目使用的时候就直接可以直接

npm install vaw-verify --save

就好了。是不是很方便的,大大提高了重用性和维护性。

其次就是要在 npm 网站上注册一个账号

4edc953e2c684bbe819ffa954c899c08.png

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


准备发布

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

4edc953e2c684bbe819ffa954c899c08.png

然后输入如下命令:

npm login

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

Logged in as xxxxx on https://registry.npmjs.org/.

4edc953e2c684bbe819ffa954c899c08.png

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

然后再在终端里输入

npm publish

等他发布完就ok啦~


添加忽略文件

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

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

.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?

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


写在最后

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

npm install xxxx

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

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

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

相关文章
|
7月前
项目打包报错“caniuse-lite is outdated. Please run next command `npm update`”的解决方案
项目打包报错“caniuse-lite is outdated. Please run next command `npm update`”的解决方案
322 1
|
2月前
|
移动开发 小程序 数据可视化
基于npm CLI脚手架的uniapp项目创建、运行与打包全攻略(微信小程序、H5、APP全覆盖)
基于npm CLI脚手架的uniapp项目创建、运行与打包全攻略(微信小程序、H5、APP全覆盖)
340 3
|
2月前
|
缓存 前端开发 JavaScript
前端架构思考:代码复用带来的隐形耦合,可能让大模型造轮子是更好的选择-从 CDN 依赖包被删导致个站打不开到数年前因11 行代码导致上千项目崩溃谈谈npm黑洞 - 统计下你的项目有多少个依赖吧!
最近,我的个人网站因免费CDN上的Vue.js包路径变更导致无法访问,引发了我对前端依赖管理的深刻反思。文章探讨了NPM依赖陷阱、开源库所有权与维护压力、NPM生态问题,并提出减少不必要的依赖、重视模块设计等建议,以提升前端项目的稳定性和可控性。通过“left_pad”事件及个人经历,强调了依赖管理的重要性和让大模型代替人造轮子的潜在收益
|
2月前
|
资源调度 前端开发 安全
前端实战:基于Verdaccio搭建私有npm仓库,轻松上传与下载自定义npm插件包
前端实战:基于Verdaccio搭建私有npm仓库,轻松上传与下载自定义npm插件包
129 0
|
3月前
|
JavaScript
使用npm,快速构建第一个vue项目
本文介绍了如何使用npm快速构建第一个Vue项目。步骤包括确保安装了Node.js并且配置了正确的环境变量,创建一个空文件夹并使用VSCode打开,通过VSCode的终端执行`npm init vue@latest`命令以初始化项目,选择默认配置即可。接着安装项目依赖并启动开发服务器,最后通过浏览器访问开发服务器提供的本地地址查看项目运行结果。文章还提供了相关代码和操作截图。
|
3月前
|
缓存 JavaScript 前端开发
8种方法解决vue创建项目报错:command failed: npm install --loglevel error
该文章提供了八种解决Vue项目创建时遇到的`command failed: npm install --loglevel error`错误的方法,包括清理缓存、更换npm源、重新安装Node.js等措施。
8种方法解决vue创建项目报错:command failed: npm install --loglevel error
|
6月前
npm构建vite项目
npm构建vite项目
|
6月前
Node历史版本下载及配置npm镜像
Node历史版本下载及配置npm镜像
575 1
|
6月前
使用npm构建vite+vue+ts项目的两种方式
使用npm构建vite+vue+ts项目的两种方式
143 0
使用npm构建vite+vue+ts项目的两种方式
|
7月前
|
JSON 小程序 前端开发
小程序中使用npm安装vant组件实现按需引入减少代码包大小,避免触发用户隐私协议
微信小程序按需引入 vant 组件,自动清除项目中未使用的 vant 组件,减少代码包大小,避免因未使用到的 vant 组件触发隐私协议提交审核时被拒
94 1
小程序中使用npm安装vant组件实现按需引入减少代码包大小,避免触发用户隐私协议

推荐镜像

更多
下一篇
DataWorks