---
url: /docs/3.0/start/install.md
---
# 项目安装

## 环境要求

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

## 安装

### 准备

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

* [git 代码管理](https://git-scm.com/downloads)
* [composer PHP 包管理器](https://getcomposer.org/download/)
* [nodejs >= 22 ](https://nodejs.org/zh-cn/)
* [yarn 前端包管理器](https://yarn.bootcss.com/)
* [vite](https://cn.vitejs.dev/)

:::tip
如果你是第一次使用或者需要一个完整的集成环境，CatchAdmin 官方也提供了一个 Laravel 入门教程，目前正在完善中。
可以尝试使用该文档 [Laragon 集成环境安装](https://laravel-study.catchadmin.com/hello-laravel.html#%E7%8E%AF%E5%A2%83%E5%87%86%E5%A4%87)
:::

## composer 安装

:::info
如果已经安装 请跳过该步骤
:::
请确保已经安装了 `composer` 包管理器。如果您使用的是 `Mac OS` 或者 `Linux`，可以在终端输入以下命令安装 `composer`

```shell
// mac os
brew install composer

// linux
sudo apt-get install composer
```

如果您使用的是 `Windows` 系统，可以从 [composer](https://docs.phpcomposer.com/) 的官方网站下载 exe 安装文件进行安装。

## 第一种方式: 安装器安装 CatchAdmin 项目

安装器只是为了简化安装项目过程，如果遇到问题（一般是网络问题）。请使用下面的 `下载项目` 的步骤

```shell
composer global -W require catchadmin/installer

# MacOs 系统需要添加环境变量
export PATH="$HOME/.composer/vendor/bin:$PATH"
```

安装成功之后使用下面的命令

```shell
catch new catchadmin
```

会看到如图所示的
![catchadmin 快速安装](https://image.catchadmin.com/202504191018871.png)
可以选择对应的项目，默认是 Laravel 版本的。按照命令行提示输入即可。最后安装完成后会出现下面的提示
![catchadmin 快速安装](https://image.catchadmin.com/202504191022429.png)

## 第二种方式: 手动安装

### 下载项目

:::info
目前最新代码在 Gitee，Github 网络越来越不好了。Gitee 比较流畅
:::

接下来，您需要下载 CatchAdmin 项目。您可以前往该项目在 [CatchAdmin](https://gitee.com/jaguarjack/catchAdmin) 上的页面进行下载，也可以使用 `git` clone 命令将代码克隆到本地，这样就能及时获取代码更新。

```sh
git clone https://gitee.com/catchadmin/catchAdmin.git
```

当然你也可以使用 [Github](https://github.com/JaguarJack/catch-admin), 有可能会同步不及时。

请注意，该项目不提供 Web 安装方式，因此您需要使用命令行方式进行安装。接下来您可以进入 `CatchAdmin` 项目所在的目录，并运行以下命令进行安装：

```shell
# 请一定使用代理安装依赖，据目前所知，国内的 composer 镜像不是不更新了就是更新延后
# 配置完镜像使用 composer 安装
composer install
```

然后使用下面的命令安装

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

// 上传显示图片需要软连接
php artisan storage:link

// 启动后台
php artisan serve

```

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

### 手动安装前端项目

如果使用 `catch:install` 安装前端项目失败，那么你可以手动安装它。[前端项目仓库](https://gitee.com/catchadmin/catch-admin-vue.git)

```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 项目后台，通过后台管理来访问
:::

## 启动

### 手动启动

打开一个 CMD 窗口，然后到项目根目录 使用下面的命令

```shell
php artisan serve
```

新打开一个 CMD 窗口然后继续进入到 web 目录

```shell
cd web

yarn dev
```

### 快捷启动

既可以用上面的两个命令分别启动项目，也可以使用下面的命令启动两个项目。

```shell
composer run dev
```

:::tip
如果你是第一次使用 Vue，建议先去看看 [Vue](https://cn.vuejs.org/) 文档，了解一下

vue 后台使用了是 `element Plus` [文档地址](https://element-plus.org)
:::