Download the PHP package the-provost/laravel-summdb without Composer

On this page you can find all versions of the php package the-provost/laravel-summdb. 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 the-provost/laravel-summdb

Informations about the package laravel-summdb

Laravel SummDB - DB Summarizer

This tool analyzes Laravel migration files and generates a summary of the database structure, including an Entity-Relationship Diagram (ERD) using Mermaid.js syntax.

GitHub stars GitHub tag

NPM

npm version NPM Downloads

COMPOSER

Packagist Version Composer Downloads

Package Name

The name of the package on the github repo is a portmanteau of 'Summed Up' to denote a summing up of the DB of the app.

The npm package name however is a clear and understandable 'laravel-db-summary'.

Installation

NPM:

You can install Laravel DB Summarizer globally using npm:

Or use it directly with npx:

COMPOSER:

You can install the package via Composer:

Usage

NPM:

There are two ways to use Laravel DB Summarizer:

  1. Interactive Mode: Run the tool without any arguments, and it will prompt you for the Laravel project path:

  2. Command Line Mode: Provide the path to your Laravel project as an argument:

COMPOSER

After installation, you can use the Laravel SummDB command:

This command will analyze your Laravel migration files and generate a summary.

Output

The script generates three files in a 'db-summary' directory:

  1. text-summary.txt: A text summary of each table, its columns, and foreign key relationships.
  2. erd.mmd: Mermaid.js ERD code that can be visualized using tools like the Mermaid Live Editor.
  3. erd.png: A PNG image of the Entity-Relationship Diagram (requires Mermaid CLI to be installed).

If you don't have Mermaid CLI installed, you can still use the erd.mmd file to generate the diagram online.

Requirements

Documentation

For detailed documentation, please refer to:

Development

To contribute or modify the tool:

Navigate to the desired package directory (js/ or php/) and follow the development instructions in the respective README.

Configuration

COMPOSER:

You can publish the configuration file with:

This will publish a laravel-summdb.php file in your config directory.

Integrating with CI/CD Pipeline

NPM:

To include Laravel DB Summarizer as part of your CI/CD pipeline, follow these steps:

  1. Install Laravel DB Summarizer in your CI environment: Add this to your CI configuration file (e.g., .gitlab-ci.yml, .github/workflows/main.yml):

  2. Run Laravel DB Summarizer: Add a step in your CI pipeline to run the tool:

  3. Archive the generated files: Configure your CI to archive the db-summary directory as an artifact. For example, in GitLab CI:

  4. Optional: Generate PNG in CI: If you want to generate the PNG in your CI pipeline, ensure Mermaid CLI is installed:

  5. Example GitLab CI configuration:

  6. Example GitHub Actions workflow:

COMPOSER:

To include Laravel SummDB as part of your Laravel CI/CD pipeline, you can add the command to your build process. For example, in GitLab CI:

By following these steps, you'll ensure that every build of your Laravel application includes an up-to-date database summary and ERD.

Note

This script parses migration files statically and may not capture all complex scenarios or dynamic schema modifications. It's designed as a quick summary tool and may not reflect the exact state of a database that has undergone manual modifications or complex migrations.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

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

Issues

If you find a bug or have a suggestion, please file an issue on the GitHub repository.

Credits

Laravel SummDB makes use of the following open-source packages:

All versions of laravel-summdb with dependencies

PHP Build Version
Package Version
Requires php Version *
laravel/framework Version *
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 the-provost/laravel-summdb contains the following files

Loading the files please wait ....