主题
安装
INFO
请注意,本章节是基于本地开发环境,需要部署,请查看部署章节
环境要求
# | 环境 | 版本 |
---|---|---|
1 | PHP | >= 8.2+ |
2 | Nginx | latest |
3 | Mysql | >= 5.7 |
4 | Node | >= 22 |
WARNING
如果你使用的是 3.x 版本,请使用 node 20 版本,在 4.0 之后,请切换到 node22
准备
在安装这个软件之前,您需要准备一些必要的工具,包括:
# | 必须 | 官网 |
---|---|---|
1 | composer PHP 包管理器 | https://getcomposer.org/download/ |
2 | nodejs(>= 22 ) | https://nodejs.org/zh-cn/ |
3 | yarn 前端包管理器 | https://yarn.bootcss.com/ |
4 | vite | https://cn.vitejs.dev/ |
WARNING
一定要安装好上面的工具之后,在进行下面的操作,不然会失败
下载代码
默认你已经购买了专业版,那么可以到下面如图 在授权仓库进行下载。这里分三种方式,分别解释下。
- 版本: 阶段性稳定功能的版本,可以在更新里面看到 版本更新日志
- 分支: 分支功能都是优先于版本的,都是直接提交的,你可以当作开发分支来看,不保证稳定性。
- 补丁:版本之间的 diff 差异,例如你目前正在使用
v3.5.0
,需要升级到v4.0.0
,就需要下载v4.0.0
的补丁。需要注意的是补丁不会跨版本。
你可以根据实际情况下载代码包,代码包都是 zip
文件,在解压之后进行下面下一步项目安装。
项目安装
WARNING
一定要准备好上面说的安装工具,在没有准备好之前,不要进行安装。无法成功
命令行认证
INFO
推荐使用该方式安装
专业版提供一个非常方便的认证脚本,通过它进行认证然后安装项目依赖。进入到项目根目录,使用下面的代码
首先获取授权码,在授权码页面获取,点击生成授权码之后。记得保存,页面不做二次展示
进入到源码解压之后的根目录,然后使用下面的命令
shell
php auth 邮箱 这里替换成生成的授权码
# 假设你的邮箱是 catch@pro.com,授权码是 123456 , 那么需要执行如下的命令
php auth catch@pro.com 123456
WARNING
系统会对每个账户下载来源统计,所以请不要泄露账户。如果出现不寻常的情况,我们会对账户进行一些限制。如果有误,烦请联系管理员
等待项目安装完所需要的依赖包(注意这里安装的是 PHP 项目所需要的依赖
)。依赖安装完成之后,还需要安装项目的基本信息,使用下面的命令
shell
# 安装后台, 按照提示输入对应信息即可
php artisan catch:install
TIP
如果到正式环境需要初始化项目,请使用 php artisan catch:install --prod
前端项目
INFO
以下步骤实际上已经在 catch:install 中自动完成,如果因为某些原因需要手动安装,请按照下面的步骤
前端项目在根目录的 web
目录下
shell
cd web
# 安装镜像(如果有代理,请忽略)
yarn config set registry https://registry.npmmirror.com
# 安装完成之后, 使用
yarn install
进入到 web
目录,然后配置一个 .env
文件, 内容如下
TIP
catch:install 已经自动帮你设置了好了,如果需要,你可以按照下面的内容自行修改
shell
# 记住一定要加上 api/ 前缀
VITE_BASE_URL=http://127.0.0.1:8000/api/
# 项目名称
VITE_APP_NAME=xxx项目
启动命令
使用下面的命令来启动前端的开发服务器
shell
yarn dev
WARNING
注意不能直接访问 PHP 项目,会导致 Exception,前后端分离,需要通过 API 接口形式访问,所以你需要安装 VUE 项目后台,看到数据的展示
如果你是第一次使用 Vue,建议先去看看 Vue 文档,了解一下 vue 后台使用了是 element Plus 文档地址
启动项目
在 4.0.0 版本,专业版新增了快捷启动项目的命令。这个开发命令可以不需要使用
php artisan serve
和yarn dev
shell
composer run dev
WARNING
如果你本地环境使用了集成环境,配置了本地域名,并且使用 nginx 或者 apache 等等 web 服务器进行访问的话,那么就不要使用这个命令了。单独使用上面的前端项目方式
cd web
后使用 yarn dev
如何实现
这里仅作介绍,防止遇到问题你无法解决。
这个命令的服务端之后监听
8000
端口。其他端口请修改composer.json
里面的命令需要
concurrently
组件,一般情况下是自带的,没有就安装下。全局安装npm install -g concurrently