详细步骤

2019-03-12 10:16:36
Catouse
1317
最后编辑:朱宝鑫 于 2019-06-26 21:38:00

下面的内容适合新手,包含详细步骤和注意事项。

1. 安装 Nodejs 和 npm

访问 Nodejs 官网下载并安装 nodejs,选择一个适合你的操作系统的安装包,按照官方提示安装即可。虽然不同的 nodejs 版本都可以运行喧喧,但可能需要额外的配置,建议你下载与喧喧开发者相同版本的 nodejs 版本。喧喧开发人员目前使用的 nodejs 环境版本是  8.11.3,可以在这个页面  https://nodejs.org/zh-cn/download/releases/ 找到对应版本的下载地址。

Windows 和 Mac 系统用户可以直接下载非常方便的一键安装包,安装完成后打开命令行窗口(Mac 下为应用 “终端”,Windows 下为程序 “命令提示符” 或 “PowerShell”)输入如下命令查询安装后的版本号,如果输出正确版本号说明安装成功。

$ node -v

输出:

v8.11.3

如果 nodejs 安装成功,npm 也会一起安装完成,输入npm -v来检查已安装的 npm 版本。

$ npm -v

输出:

5.6.0

2. 下载喧喧源码

如果你的系统安装有 git,只需要在命令行执行如下命令来下载最新版的喧喧源码:

$ git clone https://github.com/easysoft/xuanxuan.git

下载完成后就会在你的系统创建一个名称为xuanxuan的目录,该目录内就是喧喧最新的源码,其中客户端源码在xxc目录,以下所有操作都是在xxc目录下进行。

$ cd xuanxuan/xxc

如果你还没有安装或使用过  git 也不用担心,你仍然可以访问  喧喧在 Github 上的页面,直接点击  “Download ZIP” 来下载源码。下载完成后将 zip 文件解压到xuanxuan目录下即可。

3. 安装项目依赖

从命令行进入下载好的喧喧源码目录(以下默认为xuanxuan/),执行如下命令:

$ npm install

安装失败?

此步骤通常需要几分钟,视网络环境执行的时间不定。如果你使用的是国内网络,可能导致某些依赖模块安装失败。下面介绍使用国内  淘宝 NPM 镜像 来加速安装过程,确保安装成功。以下经验适合任何基于 nodejs 的项目。

将镜像地址写入~/.npmrc

在你的系统找到~/.npmrc文件,并用文本编辑器打开,写入如下内容到文件:

registry=https://registry.npm.taobao.org/
disturl=https://npm.taobao.org/dist

注意:.npmrc文件在系统的个人文件目录下,在不同的操作系统上对应的路径不同,Windows 用户通常次文件在C:/Users/UserName/.npmrc,Mac 用户通常此文件在/Users/UserName/.npmrc。

写好配置后可以使用npm info命令检查下是否生效,以下为查看  ZUI 为例:

$ npm info zui

如果在命令行输出信息的结尾找到 ZUI 的下载地址为registry.npm.taobao.com,说明配置生效了。

dist:{ 
    shasum: '134f986bc53a62be2310a0438918b8a17b58c80c',
    size: 9957159,
    noattachment: false,
    tarball: '**http://registry.npm.taobao.org/zui/download/zui-1.6.0.tgz**' },
    publish_time: 1489730305654 
}

这样再次执行npm install命令就可以使用国内的淘宝镜像进行依赖模块的安装了。

安装 Electron 失败?

设置 ELECTRON_MIRROR 环境变量

设置 Electron 环境变量,在 Mac 或 Linux 下执行:

$ export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"

Windows 用户需要打开系统属性面板来设置环境变量(变量名称为ELECTRON_MIRROR,值为https://npm.taobao.org/mirrors/electron/)。

做了如上设置后,请重新执行npm install。
Windows 用户注意,设置新的环境变量之后需要重新打开一个命令行窗口,所设置的环境变量才会生效。

单独安装 Electron

如果仍然遇到问题,你可以尝试单独先安装 Electron,Mac 或 Linux 用户执行:

ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/" npm install electron

Windows 用户无法运行上面的命令,仍然

$ npm install cross-env -g

然后再执行:

cross-env ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/" npm install electron

这样就可以强制从淘宝镜像安装 Electron。

其他资源

如果你还有其他问题,请参考如下内容:

4. 启动开发服务器

如果你最后一次执行npm install没有出现任何错误,就可以启动开发服务器了。

启动 React 热更新服务器

在命令行窗口执行如下命令:

$ npm run hot-server

如果你在命令行窗口看到如下内容,说明 React 热更新服务器成功启动:

npm run hot-server 运行成功截图

热更新服务器用于监听源码文件更改,当你更改了源码之后会立即重新编译并通知界面组件进行刷新。这是一种所见即得的开发模式,也就是说你在源代码中的更改会即时反馈到界面上来。

注意:只有 React 组件模块会直接中界面上更新,如果是其他模块虽然仍然会实时编译,但并不会进行实时更换,此时你可以在界面上按页面刷新快捷键(Windows 为F5,Mac 用户为Command+R)来重新载入界面。

启动客户端

打开一个新的命令行窗口(不要关闭之前打开的正在运行的热更新服务器命令行窗口)执行:

$ npm run start-hot

如果你在命令行窗口看到如下内容,说明客户端启动成功:

npm run start-hot 运行成功截图

首次启动时间过长

当首次执行npm run start-hot时,Electron 会尝试下载安装REACT_DEVELOPER_TOOLS方便进行 React 开发调试,此时命令行会显示Install electron development extensions...。正常情况下只需要几分钟,但在网络不佳的话可能导致首次启动时间过长。如果超过5分钟主界面还没启动,可以尝试禁用自动安装 Electron 扩展,方法是使用npm run start-hot-fast代替npm run start-hot命令。

恭喜

通常情况下,如果以上步骤都成功,此时会在你的屏幕左侧打开一个新的窗口:窗口上方是喧喧的界面,下方是 Chrome 的开发者工具。

成功启动客户端

发表评论
评论通过审核后显示。