Skip to content

项目安装

环境要求

  • PHP >= 8.2+
  • Nginx
  • Mysql >= 5.7

安装

准备

在安装这个软件之前,您需要准备一些必要的工具,包括:

TIP

如果你是第一次使用或者需要一个完整的集成环境,CatchAdmin 官方也提供了一个 Laravel 入门教程,目前正在完善中。 可以尝试使用该文档 Laragon 集成环境安装

下载项目

接下来,您需要下载 CatchAdmin 项目。您可以前往该项目在 CatchAdmin 上的页面进行下载,也可以使用 git clone 命令将代码克隆到本地,这样就能及时获取代码更新。

sh
git clone https://github.com/JaguarJack/catch-admin.git

当然你也可以使用 Gitee, 有可能会同步不及时。

请注意,该项目不提供 Web 安装方式,因此您需要使用命令行方式进行安装。在安装之前,请确保已经安装了 composer 包管理器。如果您使用的是 Mac OS 或者 Linux,可以在终端输入以下命令安装 composer

shell
// mac os
brew install composer

// linux
sudo apt-get install composer

如果您使用的是 Windows 系统,可以从 composer 的官方网站下载 exe 安装文件进行安装。一旦您已经安装了 composer,接下来您可以进入 CatchAdmin 项目所在的目录,并运行以下命令进行安装:

shell
# 安装前,如果你没有配置过镜像,请使用下面的命令配置镜像(一定必须)
composer config -g repos.packagist composer https://packagist.pages.dev

# 配置完镜像使用 composer 安装
composer install

然后使用下面的命令安装

shell
// 安装后台, 按照提示输入对应信息即可
php artisan catch:install

// 启动后台
php artisan serve

INFO

当你使用 catch:install, 会自动下载前端项目,他们会被下载到根目录的 web 目录

手动安装前端项目

如果使用 catch:install 安装前端项目失败,那么你可以手动安装它。前端项目仓库

shell
git clone https://gitee.com/catchadmin/catch-admin-vue.git web

cd web

# 安装完 nodejs 之后,再安装 yarn
npm install --global yarn

# 在安装前记得,一定要配置镜像。否则会下载失败(一定必须)
yarn config set registry https://registry.npmmirror.com

# 安装完成之后,使用
yarn install

cp .env.example .env

# 然后添加下面的内容 .env 配置,根据实际情况修改后端访问的 api 地址
VITE_BASE_URL=PHP项目域名/api

# 启动前端项目
yarn dev

这样就可以安装所有需要的依赖包了。依赖安装完成之后,还需要安装项目的基本信息,如下

WARNING

注意不能直接访问 PHP 项目,会出现异常或者路由找不到。CatchAdmin 是前后端分离项目,你需要通过通过 API 接口形式访问。所以你需要安装好 VUE 项目后台,通过后台管理来访问

TIP

如果你是第一次使用 Vue,建议先去看看 Vue 文档,了解一下

vue 后台使用了是 element Plus 文档地址