当前位置: 首页 > news >正文

已有 npm 项目,如何下载依赖、编译并运行项目

诸神缄默不语-个人技术博文与视频目录

这篇博文的适用场景是比如说反正你现在有了一个现成的npm项目,然后无论如何,你要把前端挂起来。

文章目录

  • 一、准备工作
    • 1. 安装 Node.js 和 npm
    • 2. 克隆或获取项目代码
  • 二、安装项目依赖
  • 三、了解 npm 脚本命令
  • 四、构建生产环境代码
  • 五、运行生产环境服务器
  • 六、其他常用命令
  • 七、常见问题与解决方案
    • 1. 构建后页面空白或资源加载失败
    • 2. 构建时报错或内存不足
  • 八、总结

一、准备工作

1. 安装 Node.js 和 npm

确保已安装 Node.js,它自带 npm(Node 包管理器)。安装后,可通过以下命令验证版本:

node -v
npm -v

2. 克隆或获取项目代码

如果项目托管在 Git 仓库中,可使用以下命令克隆项目:

git clone <项目仓库地址>
cd <项目目录>

二、安装项目依赖

在项目根目录下,执行以下命令安装项目所需的依赖包:

npm install

此命令会根据 package.json 文件中的 dependenciesdevDependencies 字段,下载并安装所有依赖包到 node_modules 目录中。

如果遇到依赖冲突、安装失败或缓存问题,可以使用 --force 参数强制安装。会忽略本地缓存强制从镜像拉取包。
但是使用 --force 参数可能会导致安装不兼容的依赖,进而引发运行时错误。应谨慎使用,确保不会引入新的问题。

由于网络问题,所以直接从npm官方镜像下载可能下不下来,建议的解决方案是用镜像,如淘宝镜像:config set registry https://registry.npmmirror.com/
还有其它下载问题可以参考我写的另一篇博文:npm install --force从源无法下载包(ETARGET或E451),也没有自动新建node_modules文件夹,如何通过手动新建文件夹和下载指定无法下载的包来解决问题

三、了解 npm 脚本命令

package.json 文件中,scripts 字段定义了可执行的脚本命令。例如:

"scripts": {"build:prod": "vue-cli-service build --mode production","serve:prod": "node server.js"
}

其中:

  • build:prod:构建生产环境代码,通常包括代码压缩、优化等操作。
  • serve:prod:启动生产环境服务器,通常用于本地预览构建后的项目。

四、构建生产环境代码

执行以下命令构建生产环境代码:

npm run build:prod

该命令通常会执行如下操作:

  1. 设置环境变量为生产环境(如 NODE_ENV=production)。
  2. 使用构建工具(如 Webpack、Vite)进行代码打包、压缩、优化。
  3. 生成构建后的文件,通常位于 distbuild 目录中。

构建完成后,可在 dist 目录中看到生成的静态文件,如 index.htmljscss 等。

五、运行生产环境服务器

构建完成后,可使用以下命令启动本地服务器,预览生产环境效果:

npm run serve:prod

该命令通常会执行一个 Node.js 脚本(如 server.js),使用如 Express、Koa 等框架,启动一个本地服务器,监听特定端口(如 8080),并提供静态文件服务。

访问输出中展示的网址(一个本机访问的网址,如http://localhost:8080;一个其他设备方位的网址) 即可预览构建后的项目。

六、其他常用命令

除了上述命令,项目中可能还定义了其他脚本命令,如:

  • npm run dev:启动开发环境服务器,支持热更新,便于开发调试。
  • npm run lint:使用 ESLint 等工具检查代码规范。
  • npm run test:运行测试用例。

可通过以下命令查看所有可用的脚本命令:

npm run

七、常见问题与解决方案

1. 构建后页面空白或资源加载失败

可能原因是资源路径配置不正确。

解决方案

在构建配置文件中(如 vue.config.jswebpack.config.js),将 publicPath 设置为相对路径:

module.exports = {publicPath: './'
};

2. 构建时报错或内存不足

可能原因是构建过程中消耗内存过多。

解决方案

增加 Node.js 的内存限制,在构建命令中添加 --max_old_space_size 参数:

node --max_old_space_size=4096 node_modules/.bin/vue-cli-service build --mode production

或在 package.json 中的 scripts 中配置:

"scripts": {"build:prod": "node --max_old_space_size=4096 node_modules/.bin/vue-cli-service build --mode production"
}

八、总结

通过上述步骤,我们可以在已有的 npm 项目中,完成依赖安装、生产环境构建以及本地预览等操作。

掌握这些基本命令和配置,有助于提高开发效率,确保项目在不同环境下的正常运行。

如需进一步了解构建工具的高级配置(如 Webpack、Vite 等),建议查阅相关官方文档或社区教程。

相关文章:

  • STM32 RTC配置
  • JQ6500语音模块详解(STM32)
  • Android 热点开发调试总结
  • locust压力测试
  • LeetCode热题100--560.和为K的子数组(前缀和)--中等
  • ubuntu安装docker,conda,tmux,btop,nvitop
  • ai环境cuda cudnn conda torch整体迁移 wsl docker
  • vue的生命周期 以及钩子
  • 第二章:Agent System
  • 【亚马逊云】AWS Wavelength 从理论讲解到实验演练
  • AWS PrivateLink vs Lattice:深度解析两大网络服务的异同
  • python_股票月数据趋势判断
  • [leetcode]2302.统计得分小于k的子数组
  • java 使用 POI 为 word 文档自动生成书签
  • 学生管理系统审计
  • 【Java ee初阶】多线程(4)
  • 第十一节:性能优化高频题-响应式数据深度监听问题
  • 大模型(LLMs)强化学习—— PPO
  • Android wifi开发调试总结
  • NIPS2021 | 视觉 Transformer 的有趣特性
  • 解放日报头版:人民城市共建共享展新卷
  • 港理大公布多项AI+医工成果,助港建设国际医疗创新枢纽
  • 劳动最光荣!2426人受到表彰
  • 新任海南琼海市委副书记陈明已主持市政府党组全面工作
  • 乌克兰否认俄收复库尔斯克州,称战斗仍在持续
  • 国家数据发展研究院在京正式揭牌