Download the PHP package rich-id/tour-bundle without Composer

On this page you can find all versions of the php package rich-id/tour-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package tour-bundle

Getting Started With RichIdTourBundle

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

Package version Actions Status Coverage Status Maintainability contributions welcome

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:

Now that you declared the tours, you can now use the Javascript functions to whether execute a tour or not:

Table of content

  1. Installation
  2. Getting started
    • Configuration
    • Helpers
    • Administration
  3. Versioning
  4. Contributing
  5. Hacking
  6. License

1. Installation

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

1.1 Composer

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.

1.3 Mandatory configuration

Add in config/routes the definition of the bundle routes:

You will also need to configure the user class. Add the following configuration in the rich_id_tour.yaml file:

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

  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

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

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.

6. License

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

See LICENSE for details.


All versions of tour-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
doctrine/orm Version ^2.7 || ^3.0
richcongress/bundle-toolbox Version *
symfony/event-dispatcher Version ^6.0 || ^7.0
symfony/http-foundation Version ^6.0 || ^7.0
symfony/security-bundle Version ^6.0 || ^7.0
symfony/twig-bundle Version ^6.0 || ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rich-id/tour-bundle contains the following files

Loading the files please wait ....