weareunite/unisys-api

Unisys 基础 API 框架。


README

Unisys 基础 API 框架由 Unite 开发。

要求

Unisys API 框架需要

  • PHP 7.1+
  • 支持 json 字段的数据库,如 MySQL 5.7 或更高版本。

它使用 Laravel 5.6,因此必须满足其所有要求 https://laravel.net.cn/docs/5.6/installation#server-requirements

安装

创建新的 UniSys 项目

对于基于 Laravel 5.6 的干净 API 框架,您可以使用 weareunite/unisys-installer 来完成所有繁琐的工作。让我们全局安装它。

composer global require "weareunite/unisys-installer"

现在您可以创建一个新的 Unisys 框架

unisys new project_name

这将安装所有依赖项,发布所有重要的供应商配置,迁移,设置一些配置,并运行迁移。

命令将生成并打印默认管理员账户的密码。不要忘记记住这个密码

将 Unisys 添加到现有项目中

或者,您还可以使用现有的 Laravel 5.6 应用程序。从以下两个主要包开始

composer require weareunite/unisys-api

要安装此包,请使用

php artisan unisys-api:init-env

之后

php artisan unisys-api:install

这将安装所有依赖项,发布所有重要的供应商配置,迁移,设置一些配置,webpack 配置并运行迁移。

命令将生成并打印默认管理员账户的密码。将此密码保存到您的剪贴板,我们很快就会需要它。

要求

将您的 DSN 添加到 .env

SENTRY_LARAVEL_DSN=https://public:secret@sentry.example.com/1

优化工具

Medialibrary 将使用这些工具来 优化转换后的图像 如果它们存在于您的系统上

以下是如何在 Ubuntu 上安装所有优化器

sudo apt-get install jpegoptim
sudo apt-get install optipng
sudo apt-get install pngquant
sudo npm install -g svgo
sudo apt-get install gifsicle

以下是如何在 MacOS 上安装二进制文件(使用 Homebrew

brew install jpegoptim
brew install optipng
brew install pngquant
brew install svgo
brew install gifsicle

要创建派生图像,服务器上应安装 GD。对于创建 svg 或 pdf 的缩略图,还应该安装 Imagick

Wkhtmltopdf 安装

选择以下选项之一来安装 wkhtmltopdf/wkhtmltoimage。

  1. 这里 下载 wkhtmltopdf;
  2. 或作为 composer 依赖项安装。有关更多信息,请参阅 wkhtmltopdf 二进制文件作为 composer 依赖项

测试

  1. .env.example 复制到 .env 并填写您的数据库凭据。
  2. 运行 vendor/bin/phpunit

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件