bedita/manager

BEdita Manager - BEdita4 API的官方管理Web应用

安装: 531

依赖项: 0

建议者: 0

安全性: 0

星标: 12

关注者: 8

分支: 11

开放问题: 6

类型:项目

v4.35.0 2024-09-19 10:17 UTC

This package is auto-updated.

Last update: 2024-09-19 10:18:21 UTC


README

Github Actions PHP Github Actions Javascript codecov phpstan psalm Scrutinizer Code Quality Version License

BEdita API的后端管理器。

先决条件

  • 支持的PHP版本:7.4、8.0、8.1、8.2和8.3
  • Composer
  • Node >= 16
  • Yarn >= 1.15

安装

  • 通过composer创建项目
composer create-project bedita/manager

这将创建一个新的manager文件夹并安装composer依赖项。如果您使用的是.zip.tar.gz版本文件,您只需要解压它,然后运行composer install。如果您在这个仓库上执行git clone,也需要运行相同的命令。

  • manager文件夹使用yarn构建JS/CSS包
yarn && yarn build
  • config/.env中配置BEdita API基本URL和API KEY,例如
# set BEDITA base URL
export BEDITA_API="{bedita-url}"
# set BEDITA API KEY (optional)
export BEDITA_API_KEY="{bedita-api-key}"

要测试Web应用,您可以从manager文件夹简单地运行内置的Web服务器,如下所示

bin/cake server

然后,将您的浏览器指向http://localhost:8765/

对于除简单测试以外的任何用途,我们建议您配置您首选的Web服务器(如Nginx/Apache),并将webroot/设置为虚拟主机文档根。

## 配置

您可以在config/app_local.php中进一步配置您的BEdita Manager实例,使用环境和项目特定的设置。

请参阅Manager配置wiki页面了解如何自定义您的Manager实例。

Docker

拉取官方镜像

从Docker Hub获取最新的官方镜像构建

docker pull bedita/manager:4

构建镜像

如果您想从本地源构建镜像,您可以从根目录这样做

docker build -t manager-local .

当然,您可以自由选择为生成的镜像命名,而不仅仅是manager-local

运行

以这种方式运行Docker镜像,设置API基本URL和API KEY

docker run -p 8080:80 \
    --env BEDITA_API={bedita-api-url} --env BEDITA_API_KEY={bedita-api-key} \
    bedita/manager:latest

bedita/manager:latest替换为manager-local(或您选择的任何名称)以启动本地构建的镜像。

使用webpack进行JS开发

使用.env

配置config/.env以匹配您的Web服务器和代理要求很简单,如下所示。(默认代理:localhost:8080,默认服务器:localhost:3000)

# BE Manager Entry Point
WEBPACK_SERVER_HOST=localhost
WEBPACK_SERVER_PORT=3000

# Proxy server
WEBPACK_PROXY_HOST=local-be4-web
WEBPACK_PROXY_PORT=8080

要启动开发模式,请运行

yarn develop

使用Bundle Report进行生产构建

yarn run bundle-report

ESlint

  • 通过yarn运行ESlint,检查js文件上的linting
yarn run eslint resources/js/app/pages/admin/index.js

运行单元测试

要本地设置测试,只需将tests/.env.example复制到tests/.env,并相应地设置环境变量。要启动测试

vendors/bin/phpunit [test folder or file, default '/tests']

要运行这些测试,您可能希望使用Docker镜像作为BEdita4 API端点。例如,如果您可以通过docker pull bedita/bedita:4docker pull bedita/bedita:5拉取Docker镜像

然后您可以通过以下方式运行该镜像

docker run -p 8090:80 --env BEDITA_ADMIN_USR=bedita --env BEDITA_ADMIN_PWD=bedita bedita/bedita:5

然后您可以根据以下方式设置环境变量

export BEDITA_API="http://localhost:8090"
export BEDITA_ADMIN_USR="bedita"
export BEDITA_ADMIN_PWD="bedita"

然后您就可以开始了

许可

BEdita是在LGPL( Lesser General Public License v3)下发布的。