Download the PHP package spryker-community/oms-visualizer without Composer

On this page you can find all versions of the php package spryker-community/oms-visualizer. 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?

Example code of spryker-community/oms-visualizer

Informations about the package oms-visualizer

OMS Visualizer

A modern visualization tool for Spryker OMS (Order Management System) process flows. This package provides an enhanced, user-friendly way to visualize and interact with OMS graphs in your Spryker application.

✓ Tested with Spryker B2B-Demoshop 202410.0

Features

Setup

1. Install Package

Install the package via Composer:

2. Integrate ZED Controller

To make the OMS Visualizer accessible through your Spryker application, follow these steps:

  1. Add the SprykerCommunity namespace to CORE_NAMESPACES in your project's config_default.php file:

  2. Run the following console commands inside the docker/sdk cli to update caches:

These commands refresh the router cache, generate transfer objects, and warm up the Twig template cache to ensure your changes take effect.

3. Install Frontend Assets

The OMS Visualizer uses Mermaid JS for graph visualization. Follow these steps to install the necessary frontend dependencies and assets:

  1. Add the spryker-community workspace to the root package.json of your project:

  2. Install all JavaScript dependencies from the /vendor/spryker-community directory and compile them for use in your Zed application:

  3. Create a new file at ./frontend/zed/build.js with the following content:

  4. Update your project's package.json file to include your ./frontend/zed/build.js as build script:

Note: Replace "other-scripts" with your existing script entries.

  1. Run the build command to install and compile the frontend assets:

4. Add navigation entry

To have a separate navigation menu for the new OMS Visualizer, copy the content from src/SprykerCommunity/Zed/Communication/navigation.xml into your config/Zed/navigation.xml.

Clear the cache for navigation:

Troubleshooting

Common Issues

Incompatible Version of Chevrotain

If you encounter errors related to the chevrotain npm module, you may need to install a compatible version:

This resolves a breaking dependency issue that can occur with newer versions of the package.

Usage

After installation, you can access the OMS Visualizer through your Zed application's interface. Navigate to the OMS section to view and interact with your process flow visualizations.

Development

Running Tests

The OMS Visualizer includes a suite of unit tests to ensure code quality and functionality. To run the tests:

  1. Make sure you have installed the development dependencies:

  2. Run the PHPUnit test suite:

The test suite includes:

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you encounter any issues or have questions, please open an issue in the GitHub repository.

License

This package is released under the MIT license.

All versions of oms-visualizer with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
spryker/kernel Version ^3.52.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 spryker-community/oms-visualizer contains the following files

Loading the files please wait ...