Xin Admin

    快速开始

    欢迎使用 XinAdmin！本指南将指导您完成最基本的安装、配置，并在不到 10 分钟内成功部署您的第一个项目。

    系统要求

    在安装之前，请确保您的系统符合以下要求：

    项目最低版本推荐版本是否必须
    PHP8.28.2+是
    MySQL5.78.0+是
    Redis4.06.0+是
    Composer2.02.4+是
    Node.js18.022.0+是
    npm8.010.0+是
    pnpm7.08.0+否

    项目安装

    1. 克隆项目

    git clone https://github.com/xin-admin/xin-admin-laravel.git

# 切换到项目目录以便执行后续操作

cd xin-admin-laravel

    2. 安装依赖

    使用 composer 包管理器 安装 php 依赖

    composer install

    3. 环境文件配置

    cp .env.example .env

    然后根据您的数据库配置修改 .env 文件：

    DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=xinadmin
DB_USERNAME=root
DB_PASSWORD=

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
    Tip

    在生产环境中，请务必修改数据库密码和 Redis 密码，确保系统安全。

    4. 生成 APP_KEY

    php artisan key:generate

    5. 执行数据库迁移

    php artisan migrate --graceful
    Info

    --graceful 参数确保在迁移失败时不会中断整个过程，可以安全地处理已存在的表。

    6. 初始化数据

    运行以下命令，将初始的数据填充到数据库中，初始数据包含 root 管理员信息、菜单与权限信息等。

    php artisan db:seed

    7. 安装前端依赖

    使用 npm 或者 pnpm 来安装前端所需的依赖

    npm install
# or
pnpm install
    Warning

    如果您的系统未安装 pnpm，可以通过 npm install -g pnpm 命令安装。

    8. 启动开发服务器

    通过 composer 脚本一键运行前后端服务，后端接口将被运行在 http://localhost:8000 服务上，前端运行在 http://localhost:5173 服务上。

    composer run-script dev

    如果控制台输出以下内容即运行成功：

    [vite] 
[vite] > xin-admin-ui@0.0.0 dev
[vite] > vite
[vite] 
[vite] 
[vite]   VITE v7.3.1  ready in 1319 ms
[vite] 
[vite]   ➜  Local:   http://localhost:5173/
[vite]   ➜  Network: use --host to expose
[queue] 
[queue]    INFO  Processing jobs from the [default] queue.  
[queue] 
[server] 
[server]    INFO  Server running on [http://127.0.0.1:8000].  
[server] 
[server]   Press Ctrl+C to stop the server
[server]

    此时，你可以通过访问 http://localhost:5173/ 来进入管理后台的登录页面

    首次登录

    程序启动成功！现在打开浏览器访问：

    前端地址: http://127.0.0.1:3000/login

    使用以下凭证登录：

    用户名: admin
密码: 123456

    常见问题

    Q: Composer 安装失败

    正常情况下安装失败会有以下几种原因：

    1.网络问题，网络连接不稳定或防火墙/代理服务器阻止访问，建议使用国内镜像源加速安装。

    2.缺少PHP扩展,确保系统信任存储库的SSL证书，并检查是否缺少Composer所需的PHP扩展。