PHPackages rich-id/tour-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. rich-id/tour-bundle ActiveSymfony-bundle rich-id/tour-bundle =================== A tour bundle for Symfony 6.0 v3.0.0(1y ago)140.9k↓46.9%MITPHPPHP ^8.1 Since May 17Pushed 2mo ago1 watchersCompare [ Source](https://github.com/rich-id/tour-bundle)[ Packagist](https://packagist.org/packages/rich-id/tour-bundle)[ RSS](/packages/rich-id-tour-bundle/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (7)Dependencies (8)Versions (12)Used By (0) [![Logo](.github/tour-bundle.svg)](.github/tour-bundle.svg) Getting Started With RichIdTourBundle ===================================== [](#getting-started-with-richidtourbundle) This version of the bundle requires Symfony 6.0+ and PHP 8.1+. [![Package version](https://camo.githubusercontent.com/d1fb825e7b192ecfd3c72eb9fd0fbe97c99319cefde112011cb905a6bb4cbb3b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f726963682d69642f746f75722d62756e646c65)](https://packagist.org/packages/rich-id/tour-bundle)[![Actions Status](https://github.com/rich-id/tour-bundle/workflows/Tests/badge.svg)](https://github.com/t/rich-id/tour-bundle/actions)[![Coverage Status](https://camo.githubusercontent.com/0040e6c0ea148bc10a850f88b04fcaf7ca82e3b30c619a844e271da1088cad94/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f726963682d69642f746f75722d62756e646c652f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/rich-id/tour-bundle?branch=master)[![Maintainability](https://camo.githubusercontent.com/7e583f511f5d0ca18116cc4de462fd01d573a280421432d1336ce02935a454a6/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f64396536323866346531323365633939396135372f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/rich-id/tour-bundle/maintainability)[![contributions welcome](https://camo.githubusercontent.com/9e93e892d0685e1bf7a1d0bd7c8410d6ecf2086a0a7b48dd58a6b96fa556ea2a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f6e747269627574696f6e732d77656c636f6d652d627269676874677265656e2e7376673f7374796c653d666c6174)](https://github.com/rich-id/tour-bundle/issues)[![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](LICENSE.md) The tour-bundle exposes a set of Javascript functions to easily track if a user saw a tour or not. Quick start =========== [](#quick-start) Declare the tours in Symfony's configuration: ``` 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 ``` Now that you declared the tours, you can now use the Javascript functions to whether execute a tour or not: ``` if (isTourAvailable('tour-1')) { // Make the tour markTourAsPerformed('tour-1'); } ``` Table of content ================ [](#table-of-content) 1. [Installation](#1-installation) 2. [Getting started](#2-getting-started) - [Configuration](Docs/Configuration.md) - [Helpers](Docs/Helpers.md) - [Administration](Docs/Administration.md) 3. [Versioning](#3-versioning) 4. [Contributing](#4-contributing) 5. [Hacking](#5-hacking) 6. [License](#6-license) 1. Installation =============== [](#1-installation) This version of the bundle requires Symfony 6.0+ and PHP 8.1+. ### 1.1 Composer [](#11-composer) ``` composer require rich-id/tour-bundle ``` ### 1.2 Bundles declaration [](#12-bundles-declaration) After the installation, make sure that the bundle are declared correctly within the Kernel's bundles list. This is done automatically if you use Symfony Flex. ``` return [ // ... RichId\TourBundle\RichIdTourBundle::class => ['all' => true], ]; ``` 1.3 Mandatory configuration --------------------------- [](#13-mandatory-configuration) Add in `config/routes` the definition of the bundle routes: ``` rich_id_tour: resource: "@RichIdTourBundle/Resources/config/routing/routing.xml" ``` You will also need to configure the user class. Add the following configuration in the `rich_id_tour.yaml` file: ``` rich_id_tour: user_class: App\Entity\DummyUser # Your User class ``` 1.4 Doctrine mapping -------------------- [](#14-doctrine-mapping) The bundle provides entities. You must therefore modify the structure of your database by generating a migration. 2. Getting started ================== [](#2-getting-started) - [Configuration](Docs/Configuration.md) - [Helpers](Docs/Helpers.md) - [Administration](Docs/Administration.md) 3. Versioning ============= [](#3-versioning) tour-bundle follows [semantic versioning](https://semver.org/). In short the scheme is MAJOR.MINOR.PATCH where 1. MAJOR is bumped when there is a breaking change, 2. MINOR is bumped when a new feature is added in a backward-compatible way, 3. PATCH is bumped when a bug is fixed in a backward-compatible way. Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time. 4. Contributing =============== [](#4-contributing) Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones: - [Bug Reports](https://github.com/rich-id/tour-bundle/issues): While we strive for quality software, bugs can happen, and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved! - [Feature Request](https://github.com/rich-id/tour-bundle/issues): You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution. - [Pull Request](https://github.com/rich-id/tour-bundle/merge_requests): Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as [documentation](https://help.github.com/articles/about-pull-requests/) on pull requests. We use the ["fork and pull model"](https://help.github.com/articles/about-collaborative-development-models/) were contributors push changes to their personal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch. As a reminder, all contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md). 5. Hacking ========== [](#5-hacking) You might use Docker and `docker-compose` to hack the project. Check out the following commands. ``` # 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. License ========== [](#6-license) tour-bundle is distributed under the terms of the MIT license. See [LICENSE](LICENSE.md) for details. ### Health Score 46 — FairBetter than 93% of packages Maintenance62 Regular maintenance activity Popularity29 Limited adoption so far Community10 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 75% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~139 days Recently: every ~230 days Total 9 Last Release 714d ago Major Versions v1.0.4 → v2.0.02023-03-06 v2.1.0 → v3.0.02024-06-03 PHP version history (2 changes)v1.0.0PHP >=7.3 v3.0.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/6bfb5e4a3dde826e4cd3f92d24fdfbdce1415c77f3edd38fc3420b4988977e13?d=identicon)[HugoDumazeau](/maintainers/HugoDumazeau) ![](https://www.gravatar.com/avatar/8084ee0162a85df3b3f49230b8c0dde81108195caa541bb00642cbd050e88b25?d=identicon)[hudumazeau](/maintainers/hudumazeau) --- Top Contributors [![NicolasGuilloux](https://avatars.githubusercontent.com/u/4090627?v=4)](https://github.com/NicolasGuilloux "NicolasGuilloux (3 commits)")[![mdevlamynck](https://avatars.githubusercontent.com/u/4378377?v=4)](https://github.com/mdevlamynck "mdevlamynck (1 commits)") ### Embed Badge ![Health badge](/badges/rich-id-tour-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/rich-id-tour-bundle/health.svg)](https://phpackages.com/packages/rich-id-tour-bundle) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[easycorp/easyadmin-bundle Admin generator for Symfony applications 4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[contao/core-bundle Contao Open Source CMS 1231.6M2.4k](/packages/contao-core-bundle)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)