Skip to main content

源码本地化部署-windows版

1、前置准备​

PagePlug 后端启动需要 Jdk17、Maven3.6及以上版本、一个Mongo5实例和一个Redis实例，请检查下电脑是否已经部署好，如果还没有的话，可以查看下面教程安装

1.1 配置Java-OpenJSDK17​

1.1.1下载JDK17​

1.1.2创建文件夹解压​

  • 在自己本地的磁盘，创建一个文件夹，例如叫java
  • 将下载好的Jdk-17包解压到文件夹下

1.1.3配置环境变量​

  • 打开电脑设置，左下角菜单选择关于，右侧选择高级系统配置，系统属性中选择高级系统设置
  • 在系统变量中，选择新建
  • 之后编辑变量名和变量值

变量名可以填写：JAVA_HOME

变量值填写jdk的安装目录（可以通过浏览目录，找到jdk的文件夹）

  • 配置好后，点击确定，再系统变量中找到Path，点击编辑
  • 点击新建，将下面命令输入进Path值
%JAVA_HOME%\bin

之后点击确定，变量就配置好了

1.1.4 测试JDK是否安装成功​

  • 打开命令行窗口即CMD命令，输入java或者javac都可以
java
javac

出现这样一堆东西，环境已经配置好了

1.2配置Maven版本在3.6及以上​

1.2.1下载​

根据不同的版本，选择对应的文件，windows选择zip的压缩包

1.2.2创建文件夹解压​

  • 在自己本地的磁盘，创建一个文件夹，例如叫java
  • 将下载好的apache-maven-3.9.0解压到java文件夹下

1.2.3配置环境变量​

  • 打开电脑设置，左下角菜单选择关于，右侧选择高级系统配置，系统属性中选择高级系统设置
  • 在系统变量中，选择新建
  • 之后编辑变量名和变量值

变量名可以填写：MAVEN_HOME

变量值填写maven的安装目录（可以通过浏览目录，找到maven的文件夹）

  • 配置好后，点击确定，再系统变量中找到Path，点击编辑
  • 点击新建，将下面命令输入进Path值
%MAVEN_HOME%\bin

之后点击确定，变量就配置好了

1.2.4 测试MAVEN是否安装成功​

  • 打开命令行窗口即CMD命令，输入
mvn -v

显示版本号证明环境已经配置好了

1.3配置MongoDB数据库（需要使用5以上的版本）​

请使用Mongo5以上的版本需要预先配置好副本集，副本集的配置教程可以点击查看文档，点击查看
mongo副本集配置 | pageplug Docs
PagePlug1.9的版本如果使用外部 mongo，需要 mongo5.0 或者更高的版本，并且需要设置 replica set
mongo副本集配置 | pageplug Docs favicon https://docs.pageplug.cn/学习文档/部署安装/mongo副本集配置

1.4配置redis数据库（自身已有redis数据库，可忽略此步骤）​

  • 打开Methodot官网，从工作台中进入到应用商店，找到redis商品
www.methodot.com
  • 选择部署
  • 配置redis，支持自定义域名，选择立即部署
  • 部署成功，可以使用

1.5git安装（如果已经有了，可忽略此步骤）​

  • 点击下方链接下载git

git下载

  • 安装在电脑的磁盘，配置可以根据个人使用喜好选择，仅供参考
  • 安装成功

1.6配置Rsync工具​

build.sh 脚本中用到了 rsync 工具，启动前请确保系统中已经安装了 rsync，Windows环境配置sync请看

  • 可以点击下方链接下载usr文件

链接: https://pan.baidu.com/s/1gKAps-7bLYGFfxiJJ5ANUw

提取码: dwfs

  • usr文件夹里面可能包含 bin、lib、share ，将 usr 文件拷贝到 Git 安装目录下即可

例如我的在C盘，/Program Files/Git

1.7在windows下安装NVM（感谢6群@Catsoft同学之前在群里的分享🥳）​

❗️注意 :由于这是部署环境变量安装的第一个章节，所以作者会详细描述安装过程，后续有相同安装过程的不会再详细描述，除非有特异性情况出现

由于本方案是使用Windows“原生”部署方式，不使用WSL所以我们需要使用coreybutler/nvm-windows项目部署 nvm，项目地址:

https://github.com/coreybutler/nvm-windows

可以直接下载:

https://github.com/coreybutler/nvm-windows/releases/download/1.1.10/nvm-setup.exe

下载后找到 “nvm-setup.exe” 可执行文件，使用右键 “以管理员身份运行” 打开安装界面，遇到如下提示请选择 “是”

安装过程中，请根据自身需要调整安装位置，如章节1前导说明第三段所说，我这里选择目 录 C:\PagePlugBase\Environment\nvm 进行安装，应用的默认目录为 C:\Users\你的用户名 \AppData\Roaming\nvm 请注意根据实测安装目录中切不可有中文，因为某些特殊中文字符会导致环境变量失效

接下来选择nvm帮助你部署nodejs的目录，请注意这个目录在安装时需要存在，所以如果你选择和默认目录不 同的路径，请手动创建病确保当前账户拥有完全控制权限，这里的默认地址是 C:\Program Files\nodejs 请根据 自己的管理需要修改。

安装完成后，打开Powershell，在Windows徽标处点击右键，选择 “终端(管理员)” 或在启动器中搜 索 Powershell 选择 “以管理员身份运行”

在打开的Powershell终端界面中输入 nvm -v (此时处于什么目录并不重要)出现返回版本号 1.1.10 即表示 nvm安装部署成功，如果出现报错找不到nvm命令或其他错误，请检查1、是否拥有nvm安装目录完全控制权限; 2、是否安装成功，环境变量是否配置到位(我也不会检查环境变量，就重装一次吧)

接下来在Powershell终端界面中输入 nvm install 16.14.0 按照官方要求部署nodejs 16.14.0版本，使用 nvm的好处是不用自己配置环境变量，同时在需要时可以使用nvm命令切换不同的nodejs版本以便测试，省去了很多折腾环境的成本，接下来只需要等待自动安装完成即可。(如果遇到网络问题安装失败听说可以替换nvm安装 源，反正我不会，或者反复执行 nvm install 16.14.0 直到安装成功为止)

安装成功后会返回如下信息：

这个时候环境变量实际还没有配置，如果直接使用node会出现如下错误，此时，我们只需要执行 nvm use 16.14.0 --default 即可设置默认nodejs环境变量为16.14.0版本，再执行 node -v 会发现Powershell已经可以 找到nodejs程序并打印版本号，成功执行

以上，整个nvm-windows的部署及NodeJS依赖环境的安装配置结束，现在已经可以使用node来进行前端编译操作啦

1.8使用nodejs中安装yarn（感谢6群@Catsoft同学之前在群里的分享🥳）​

使用管理员权限打开Powershell，此时处于什么目录不重要，在Powershell中输入 

npm install -g yarn

即可全局安装yarn，安装完成后即可看到 added 1 package, and audited 3 packages in 2s 提示，如果出 现如下升级npm的提示可以不用关心

2、源码拉取下载​

避免因权限问题导致下载失败或拉取失败，在使用git拉取的时候，**以管理员身份来运行使用**

2.1创建源码文件夹​

  • 我们可以在任意磁盘创建一个文件夹，例如在D盘创建一个work

2.2打开git bash下载​

  • 打开git bash，进入源码文件夹所在的D盘，输入以下命令
cd d:
  • 之后我们可以再进入D盘下的work文件夹，输入以下命令
cd work
  • 之后我们可以输入这个命令，查下文件夹下有无其他文件
ll
  • 复制git或者是github的地址下载
https://gitee.com/cloudtogo/pageplug.git

gitee的地址

https://github.com/cloudtogo/pageplug.git

输入以下的命令，下载源码（以gitee为例）

git clone https://gitee.com/cloudtogo/pageplug.git
  • 显示下面内容的时候，源码拉取成功

3、后端部署​

3.1检查maven在编译器的配置​

  • 点击左上角File—settings
  • 左上角搜索框搜索maven，检查下Maven home path、User settings file、Local repository是否配置有误

Maven home Path中填写Maven安装目录的位置

User settings file的文件在maven目录中，/conf/logging

Local repository可以修改或者不修改，默认在C盘，如果担心C盘存量不够，建议更换目录（我在D盘创建了一个空的local文件夹）

  • 看下在Maven的设置里面，是否勾选了这2个选项
关注确认一下，右边菜单栏是否显示Maven！！！

配置没啥问题后，我们按照从IDEA中打开源文件

3.2打开Pageplug文件​

  • 进入IDEA，我们将下载的源码从文件夹中打开
  • 等待几分钟加载，之后点击下方Terminal，进入Git Bash

我们将开始按照教程依次操作

3.3打开及配置工程文件​

  • 首先进入到app文档，输入以下命令
cd app
  • 再进入到server文档，输入以下命令
cd server
  • 按照步骤提示，我们需要创造一个步骤文件，输入以下命令
cp envs/dev.env.example .env
  • 接下来我们打开env，配置环境变量，文件路径/app/server/scripts/.env

对mongo和redis的地址进行修改

如果需要小程序预览功能，可以在这里，需要配置你的小程序信息

CLOUDOS_WECHAT_APPID=""

CLOUDOS_WECHAT_SECRET=""

  • 按照模版格式替换地址

如果没有mongo和redis，可以在methodot上部署生成使用，教程可以往上看

3.4构建Java服务​

  • 我们在git bash下，输入以下命令
mvn clean compile

等待一会时间，成功后有提示

  • build.sh 脚本中用到了 rsync 工具，启动前请确保系统中已经安装了 rsync，否则执行命令会有提醒

Windows环境安装 rsync ，可以点击下方链接

http://mysoft.6h5.cn/win/rsync.64.zip

下载完成后，解压压缩包，找到rsync.exe，把这个文件拷贝到Git Bash目录C:\Program Files\Git\usr\bin即可在Git Bash上使用了。

  • 继续操作，输入第二个命令
bash ./build.sh -DskipTests

安装成功之后会有下面的提醒

  • 检查是否有了dist文件夹
如果没有出现上面所示的plugins包，可以看下图修改下，之后再去运行一下 bash ./build.sh -DskipTestsbash

3.5启动java服务​

  • 输入第三个命令
bash ./scripts/start-dev-server.sh

看到appsmith is running就是成功了

4、前端部署​

4.1启动本地 nginx docker​

  • 我们新建一个git bash，输入以下命令，进入pageplug文件夹
cd pageplug
  • 输入以下命令，进入app文件夹
cd app
  • 输入以下命令，进入client文件夹
cd client
  • 输入以下命令，启动nginx
yarn start-proxy
如果原来电脑没有拉取过nginx，首先会拉取nginx image；同时也需要保证你本地的443端口没有被占有
  • 显示Done的时候，已经顺利启动

👇Docker里面的nginx容器启动成功👇

4.2安装依赖​

  • 输入以下命令
yarn
  • 等待几分钟，正常会显示这5步
[1/5] Validating package.json...
[2/5] Resolving packages...
[3/5] Fetching packages...
[4/5] Linking dependencies...
[5/5] Building fresh packages...
  • 最终显示如下
yarn 安装依赖，有可能会遇到网络问题，可以参考[https://segmentfault.com/a/1190000017419993](https://segmentfault.com/a/1190000017419993)

设置npm源

yarn 安装依赖， 提示报错 “cross-env找不到”，可以将package.json 的脚本里面的
cross-env
替换成
set
安装过程中，如果遇到@sentry/cli或者node-sass依赖找不到的

可以参照这个地址https://blog.csdn.net/qq_31201781/article/details/106147842'

单独设置镜像地址

如果遇到@shared/ast找不到问题，其实就是本地包的之前，需要 yarn link 建立软链接

可以参考如下操作

cd shared/ast
yarn run link-package
cd client
yarn link @shared/ast

4.3启动前端服务​

  • 输入以下命令，启动前端服务
yarn start-win
  • 等待几分钟，最终显示如下，出现warings可以忽略

4.检查是否成功​

  • 访问下面的地址，页面会显示如下
dev.appsmith.com
确保你的机器的host，已经配置了映射关系

hosts文件一般在这 C:\Windows\System32\drivers\etc\hosts

将

127.0.0.1 dev.appsmith.com

加进hosts文件