README

使用 RichIdTourBundle 入门

本版本的包需要 Symfony 6.0+ 和 PHP 8.1+。

tour-bundle 提供了一组 JavaScript 函数，可以轻松跟踪用户是否查看过导游。

快速入门

在 Symfony 的配置中声明导游

rich_id_tour:
    user_class: App\Entity\User
    tours:
        tour-1:
            name: 'My tour'
            storage: cookie
            duration: '+9 months'
        additionnal-tour:
            storage: local_storage
        another-one:
            storage: database

现在您已经声明了导游，您现在可以使用 JavaScript 函数来执行导游或跳过导游

if (isTourAvailable('tour-1')) {
    // Make the tour
   markTourAsPerformed('tour-1');
}

1. 安装

本版本的包需要 Symfony 6.0+ 和 PHP 8.1+。

1.1 Composer

composer require rich-id/tour-bundle

1.2 包声明

安装后，请确保在 Kernel 的包列表中正确声明了包。如果您使用 Symfony Flex，这将自动完成。

return [
    // ...
   RichId\TourBundle\RichIdTourBundle::class => ['all' => true],
];

1.3 必要配置

在 config/routes 中添加包路由的定义

rich_id_tour:
    resource: "@RichIdTourBundle/Resources/config/routing/routing.xml"

您还需要配置用户类。在 rich_id_tour.yaml 文件中添加以下配置

rich_id_tour:
    user_class: App\Entity\DummyUser  # Your User class

1.4 Doctrine 映射

该包提供实体。因此，您必须通过生成迁移来修改您的数据库结构。

2. 入门

3. 版本

tour-bundle 遵循语义版本控制。简而言之，方案是 MAJOR.MINOR.PATCH，其中

MAJOR 在出现破坏性更改时增加
MINOR 在以向后兼容的方式添加新功能时增加
PATCH 在以向后兼容的方式修复错误时增加

低于 1.0.0 的版本被认为是实验性的，并且任何时间都可能发生破坏性更改。

4. 贡献

欢迎贡献！有几种贡献方式，我们感激所有方式。以下是其中的一些主要方式

错误报告：虽然我们努力提供高质量的软件，但错误仍然可能发生，我们无法修复我们不知道的问题。所以请即使您不确定或者只是想提问，也请报告。事实上，任何问题都可能表明文档还可以改进！
功能请求：您有一个当前 API 未涵盖的使用场景吗？想要建议更改或添加某些内容？我们将很高兴阅读有关内容并开始讨论，以尝试找到最佳解决方案。
拉取请求：想要贡献代码或文档？我们将非常乐意！如果您需要帮助开始，GitHub 提供有关拉取请求的文档。我们使用 “分支和拉取模型”，其中贡献者将更改推送到他们的个人分支，然后创建拉取请求到主存储库。请确保您的拉取请求针对 master 分支。

提醒一下，所有贡献者都应遵循我们的行为准则。

5. 黑客攻击

您可能使用Docker和docker-compose来修改该项目。请查看以下命令。

# Start the project
docker-compose up -d

# Install dependencies
docker-compose exec application composer install

# Run tests
docker-compose exec application bin/phpunit

# Run a bash within the container
docker-compose exec application bash

6. 许可证

tour-bundle是在MIT许可证的条款下分发的。

有关详细信息，请参阅LICENSE。

rich-id / tour-bundle

维护者

详细信息