{"id":18300316,"url":"https://github.com/jpdevries/generator-modx-package","last_synced_at":"2025-07-26T21:36:04.278Z","repository":{"id":57247992,"uuid":"14814346","full_name":"jpdevries/generator-modx-package","owner":"jpdevries","description":"A yeoman generator for MODX Revolution packages.","archived":false,"fork":false,"pushed_at":"2013-11-30T09:32:51.000Z","size":132,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-15T03:32:01.681Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpdevries.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-30T03:06:28.000Z","updated_at":"2016-03-04T09:50:24.000Z","dependencies_parsed_at":"2022-08-24T16:31:22.824Z","dependency_job_id":null,"html_url":"https://github.com/jpdevries/generator-modx-package","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdevries%2Fgenerator-modx-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdevries%2Fgenerator-modx-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdevries%2Fgenerator-modx-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdevries%2Fgenerator-modx-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpdevries","download_url":"https://codeload.github.com/jpdevries/generator-modx-package/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248010631,"owners_count":21032958,"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":[],"created_at":"2024-11-05T15:12:00.521Z","updated_at":"2025-04-09T09:26:54.997Z","avatar_url":"https://github.com/jpdevries.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"generator-modx-package\n======================\n\nA yeoman generator for MODX Revolution packages.\n\n## Getting Started\nThe MODX Package Generator installs like any other npm package. From your terminal, run:\n\n```bash\nnpm install -g yo generator-modx-package\n```\n\nYou can now create a new MODX package from any directory. For example:\n\n```bash\ncd ~/Desktop/\nmkdir awesome-package \u0026\u0026 cd $_\nyo modx-package\n```\n\nYou'll be greated by a friendly fellow named yeoman and then be asked several questions. Choose your answers carefully and let's meet back here when you are through.\n\n```bash\n     _-----_\n    |       |\n    |--(o)--|   .--------------------------.\n   `---------´  |    Welcome to Yeoman,    |\n    ( _´U`_ )   |   ladies and gentlemen!  |\n    /___A___\\   '__________________________'\n     |  ~  |\n   __'.___.'__\n ´   `  |° ´ Y `\n```\n\n## Including Elements\nFor any elements you choose to include, you will find an associated directory within `core/components/awesome-package/` as well as a transport file in `_build/data`. Add your files within `core/components/awesome-package` and then reference them in the source array of the associated build file like so:\n```php\n$snippetsSource = array(\n  /* put your snippets here */\n   'myawesomesnippet' =\u003e array(\n  \t'description' =\u003e 'This is a really cool snippet located at core/components/awesome-package/elements/snippetes/myawesomesnippet.php'\n  )\n);\n```\n\n## Building Package\nAssuming you answered yes when asked to create a config file, you're `_build/build.config.php` file should already be created. Simply execute `build.transport.php` like so to build your package:\n```bash\nphp _build/build.transport.php\n```\n\nYou'll find your package in the `core/packages` directory of your `MODX_BASE_PATH`.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpdevries%2Fgenerator-modx-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpdevries%2Fgenerator-modx-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpdevries%2Fgenerator-modx-package/lists"}