https://github.com/mherrera05/data-dictionary

Bundle to expose database composition as data dictionary.
https://github.com/mherrera05/data-dictionary

doctrine json php symfony symfony-bundle

Last synced: 11 days ago
JSON representation

Bundle to expose database composition as data dictionary.

• Host: GitHub
• URL: https://github.com/mherrera05/data-dictionary
• Owner: mherrera05
• Created: 2017-11-27T16:42:19.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-16T23:29:57.000Z (about 5 years ago)
• Last Synced: 2024-11-05T08:18:20.389Z (14 days ago)
• Topics: doctrine, json, php, symfony, symfony-bundle
• Language: HTML
• Size: 29.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Symfony Bundle](https://www.forcelibre.com/wp-content/uploads/2017/10/logo-sf.png?x73297)

[![Packagist](https://img.shields.io/packagist/dt/mherrera05/data-dictionary.svg?style=for-the-badge)](https://packagist.org/packages/mherrera05/data-dictionary) [![GitHub tag](https://img.shields.io/github/tag/mherrera05/data-dictionary.svg?style=for-the-badge)](https://github.com/mherrera05/data-dictionary/tags) [![Codacy grade](https://img.shields.io/codacy/grade/fc5ba48f0fac49ab87357b5575cbb965.svg?style=for-the-badge)]() [![Packagist](https://img.shields.io/packagist/l/mherrera05/data-dictionary.svg?style=for-the-badge)](https://packagist.org/packages/mherrera05/data-dictionary) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/27857897-b592-4d7c-b415-a5609a3636ec/small.png)](https://insight.sensiolabs.com/projects/27857897-b592-4d7c-b415-a5609a3636ec)

[![knpbundles.com](http://knpbundles.com/mherrera05/data-dictionary/badge-short)](http://knpbundles.com/mherrera05/data-dictionary)

# Introduction

[Data Dictionary](https://packagist.org/packages/mherrera05/data-dictionary) is a [Symfony Bundle](http://symfony.com/doc/current/bundles.html) that offers database composition of project rendered as HTML format, making it easy for developers to read field name, data type and comments.

# Requirements

 * PHP `5.3 or higher`

 * Symfony `2.x or 3.x`

 * Doctrine Symfony Bundle `~1.4`

 * Doctrine ORM `^2.4.8`

 * Twig `^1.0||^2.0`

# Installation & Usage

This is a Symfony Bundle with dependency on Doctrine, you can install it via composer.

## Installation

### Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

```console

$ composer require mherrera05/data-dictionary "dev-master"

ó

$ composer require mherrera05/data-dictionary ">=1.0"

```

This command requires you to have Composer installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.

### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the `app/AppKernel.php` file of your project:

```php