rayenbou/dashboard-bundle

用于管理来自ticket bundle的票据的Symfony扩展包

维护者

详情

github.com/RayenBou/RayenbouDashboardBundle

源代码

问题

安装: 0

依赖者: 0

建议者: 0

安全性: 0

星级: 0

关注者: 2

分支: 0

开放问题: 1

类型:symfony-bundle

dev-main / 1.x-dev 2024-07-05 16:16 UTC

Requires

MIT ed5ff68441a64511209e6d7a615bd4c73f495c16

  • Rayen Boumaza <boumaza.rayen.woop@outlook.fr>

This package is auto-updated.

Last update: 2024-09-05 16:38:54 UTC

README

Dashboard Bundle

本项目提供对票据系统的Symfony集成，允许从指定的API获取单个票据和票据列表。它使用Symfony APIplateform来公开API并通过JWT令牌进行身份验证。

本项目旨在与Ticket Bundle一起使用。

此bundle的目的是为任何应用程序提供一种轻松集成票据系统的简单方法。

DashboardBundle部分可以安装到您的应用程序中，而TicketBundle部分可以安装到任何其他应用程序中。

此文档提供了设置项目仪表板环境的逐步指南。

目前项目处于Alpha阶段，目前没有配方，但可能会很快发生变化。

如何使用

转到/dashboard/ticket/。

然后您可以

  1. 使用自动生成的令牌作为密码创建用户。
  2. 将此令牌提供给托管Ticket Bundle的应用程序。
  3. 接收票据，通过类似消息传递的对话进行回复。
  4. 根据需要关闭/打开票据。

初始设置

  1. Composer

    composer require rayenbou/dashboard-bundle

  2. 安全设置

    首先设置安全组件

    php bin/console rayenbou:security

  3. 路由配置

    接下来，通过创建或更新config/routes/rayenbou_dashboard.yaml文件来配置仪表板的路由，内容如下

    #config/routes/rayenbou_dashboard.yaml
rayenbou_dashboard:
    resource: "@RayenbouDashboardBundle/Resources/config/routing.yaml"

  4. JWT配置

    对于JWT身份验证，您需要生成一个私有密钥和一个公共密钥。首先，为JWT创建一个目录

    mkdir -p config/jwt

    然后，生成私有密钥

    openssl genpkey -out config/jwt/private.pem -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096

    然后从私有密钥生成公共密钥

    openssl pkey -in config/jwt/private.pem -out config/jwt/public.pem -pubout

重要

请记住在配置中将密码短语替换为您的明文密码。

  1. 数据库设置

    如果您的项目尚未配置数据库，您可以创建它并使用以下命令更新模式

    php bin/console d:d:c
php bin/console doctrine:schema:update --force

测试

单元测试和集成测试正在路上。

发展

  1. 添加安全性：登录、发布和修补限制。
  2. 可以覆盖所有模板和控制器。

贡献

欢迎对此项目做出贡献。请确保遵循现有的编码风格并为任何新或更改的功能添加单元测试。

请使用PHPstan和PHP-CS-FIXER。

许可

本项目采用MIT许可证 - 有关详细信息，请参阅LICENSE文件。