README

Getting Started With RichIdTourBundle

This version of the bundle requires Symfony 6.0+ and PHP 8.1+.

The tour-bundle exposes a set of Javascript functions to easily track if a user saw a tour or not.

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

Installation
Getting started
Versioning
Contributing
Hacking
License

1. Installation

This version of the bundle requires Symfony 6.0+ and PHP 8.1+.

1.1 Composer

composer require rich-id/tour-bundle

1.2 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

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

The bundle provides entities. You must therefore modify the structure of your database by generating a migration.

2. Getting started

3. Versioning

tour-bundle follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where

MAJOR is bumped when there is a breaking change,
MINOR is bumped when a new feature is added in a backward-compatible way,
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

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

Bug Reports: 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: 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: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" 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.

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

tour-bundle is distributed under the terms of the MIT license.

See LICENSE for details.

rich-id / tour-bundle

Maintainers

Details