Download the PHP package koriym/app-state-diagram without Composer

On this page you can find all versions of the php package koriym/app-state-diagram. 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 app-state-diagram

ALPS ASD

Scrutinizer Code Quality codecov Type Coverage Continuous Integration Coding Standards Static Analysis

Release (app-state-diagram) Release (asd-action)

Produces a full application state diagram and hyperlinked documentation from ALPS file.

The diagram is hypermedia in SVG format with application states and state transitions linked to the respective semantic descriptor document HTML. The semantic descriptor document HTML is also linked to each other to represent the structure of the REST application.

Documentation

Output Demo

See online demo.

Run

There are three ways to run it: Git Hub Action.

Run with GitHub action

You can try ASD in a minute without installing any tools.

  1. Click Use this template in alps-skeleton site to create ALPS skeleton. Please make the repository public for GitHub Pages.
  2. Configuring a publishing source for your GitHub Pages site. Choose gh-pages and /(root) for the source.
  3. Each time you commit, ASD diagram and hyper linked document will be generated in https://{user}.github.io/{repository}/.

Run with Docker

This is the most standard way.

Run demo

Perform the following steps and open http://localhost:3000

ASD documen appeared? Congratulations! Press the star in this repository to celebrate. 🌟

Usage

Run locally

This method is currently mainly for developers. It is tedious and time consuming.

Requirement

You can check with the following command.

Installation

Update

Usage

The options are the same as for the Docker version.

Configuration

ASD uses an XML config file (by default, asd.xml). A barebones example looks like this:

Optional attributes

watch

You can start ASD development server with watch mode. Each time the profile file changes, the page is reloaded.

If you want to start with a specific port number, you can specify the port number at startup as follows.

markdown format

If your repository is private and your account is not a GHE or GHE Cloud account, you cannot make GitHub Pqges private. In such a case, you can output the document as Markdown and make the document private.

Unfortunately there is no way to host linked SVGs (diagrams) in Markdown, the dialog will lose the link when in Markdown.

This is an option if public HTML is not possible.


All versions of app-state-diagram with dependencies

PHP Build Version
Package Version
No informations.
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 koriym/app-state-diagram contains the following files

Loading the files please wait ....