{"id":18964249,"url":"https://github.com/mherrera05/data-dictionary","last_synced_at":"2026-05-09T00:10:58.339Z","repository":{"id":62527771,"uuid":"112221825","full_name":"mherrera05/data-dictionary","owner":"mherrera05","description":"Bundle to expose database composition as data dictionary.","archived":false,"fork":false,"pushed_at":"2019-10-16T23:29:57.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-01T05:29:59.826Z","etag":null,"topics":["doctrine","json","php","symfony","symfony-bundle"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mherrera05.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-27T16:42:19.000Z","updated_at":"2019-10-16T23:29:25.000Z","dependencies_parsed_at":"2022-11-02T15:31:40.767Z","dependency_job_id":null,"html_url":"https://github.com/mherrera05/data-dictionary","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mherrera05%2Fdata-dictionary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mherrera05%2Fdata-dictionary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mherrera05%2Fdata-dictionary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mherrera05%2Fdata-dictionary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mherrera05","download_url":"https://codeload.github.com/mherrera05/data-dictionary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239959950,"owners_count":19725221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doctrine","json","php","symfony","symfony-bundle"],"created_at":"2024-11-08T14:23:25.784Z","updated_at":"2026-04-02T20:30:15.257Z","avatar_url":"https://github.com/mherrera05.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Symfony Bundle](https://www.forcelibre.com/wp-content/uploads/2017/10/logo-sf.png?x73297)\n\n[![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)\n[![knpbundles.com](http://knpbundles.com/mherrera05/data-dictionary/badge-short)](http://knpbundles.com/mherrera05/data-dictionary)\n\n\n# Introduction\n\n[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.\n\n\n# Requirements\n\n * PHP `5.3 or higher`\n * Symfony `2.x or 3.x`\n * Doctrine Symfony Bundle `~1.4`\n * Doctrine ORM `^2.4.8`\n * Twig `^1.0||^2.0`\n\n# Installation \u0026 Usage\nThis is a Symfony Bundle with dependency on Doctrine, you can install it via composer.\n\n## Installation\n\n### Step 1: Download the Bundle\n\nOpen a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:\n\n```console\n$ composer require mherrera05/data-dictionary \"dev-master\"\nó\n$ composer require mherrera05/data-dictionary \"\u003e=1.0\"\n```\n\nThis 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.\n\n### Step 2: Enable the Bundle\n\nThen, enable the bundle by adding it to the list of registered bundles in the `app/AppKernel.php` file of your project:\n\n```php\n\u003c?php\n// app/AppKernel.php\n\n// ...\nclass AppKernel extends Kernel\n{\n    public function registerBundles()\n    {\n        $bundles = array(\n            // ...\n            new DataDictionaryBundle\\DataDictionaryBundle(),\n        );\n\n        // ...\n    }\n\n    // ...\n}\n```\n\n### Step 3: Import resources from Bundle\n\nImport bundle resources adding resources in `routing.yml`.\n\n```yaml\ndata_dictionary:\n    resource: \"@DataDictionaryBundle/Resources/config/routing.yml\"\n    prefix:   /\n```\n\nIf you prefer, you can add a prefix for URL.\n\n### Step 4: Add vendor templates\n\nAdd vendor templates directory as path in twig configuration `config.yml`.\n\n```yaml\ntwig:\n    ...\n    paths:\n        '%kernel.root_dir%/../vendor/mherrera05/data-dictionary/Resources/views': 'DataDictionaryBundle'\n```\n\n## Usage\n\n### Step 1: Import model to json files\n\nOnce installed and enabled the Bundle, you can execute the command:\n\n```bash\n$ php app/console data:dictionary:import {bundle-name}\n```\n\nThis command will export database tables and fields composition to `.json` files.\n\nUse the name of bundle where you want to put the json files. Example, Doctrine creates `orm.yml` from database on your base bundle.\n\n### Step 2: Call URL\n\nOnce files have been imported, just call the URL on web browser.\n\n```bash\n/app.php/data-dictionary\n```\n\n# Maintainer\n\nMiguel Herrera [https://github.com/mherrera05/](https://github.com/mherrera05/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmherrera05%2Fdata-dictionary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmherrera05%2Fdata-dictionary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmherrera05%2Fdata-dictionary/lists"}