{"id":18948409,"url":"https://github.com/oxid-esales/module_skeleton_generator","last_synced_at":"2026-03-16T14:01:13.032Z","repository":{"id":57034536,"uuid":"40890524","full_name":"OXID-eSales/module_skeleton_generator","owner":"OXID-eSales","description":"Folders structure, empty classes and metadata generation for new OXID eShop modules.","archived":false,"fork":false,"pushed_at":"2021-11-09T09:03:44.000Z","size":993,"stargazers_count":12,"open_issues_count":1,"forks_count":3,"subscribers_count":33,"default_branch":"master","last_synced_at":"2024-06-19T07:38:02.297Z","etag":null,"topics":["oxid-esales","oxid-module","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXID-eSales.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-17T11:51:30.000Z","updated_at":"2024-06-19T07:38:02.298Z","dependencies_parsed_at":"2022-08-23T20:50:34.981Z","dependency_job_id":null,"html_url":"https://github.com/OXID-eSales/module_skeleton_generator","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/OXID-eSales%2Fmodule_skeleton_generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fmodule_skeleton_generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fmodule_skeleton_generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fmodule_skeleton_generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXID-eSales","download_url":"https://codeload.github.com/OXID-eSales/module_skeleton_generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223688674,"owners_count":17186298,"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":["oxid-esales","oxid-module","php"],"created_at":"2024-11-08T13:13:28.927Z","updated_at":"2026-03-16T14:01:12.366Z","avatar_url":"https://github.com/OXID-eSales.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OXID Module Skeleton Generator\n\n----\n\nFolders structure, empty classes and metadata generation for new OXID eShop modules.\n\n### Concentrate only on features - let OXID Module Skeleton Generator create all the rest!\n * **Enter Your copyright data in the module settings**\n * **Open an easy to use Module Generator Wizard**\n * **Enter new module name and optional components**\n * **Press \"Generate New Module\" and its done - new module is now ready to be activated and filled with features!**\n\n## OXID Module Skeleton Generator features\n - Fully configurable vendor/author parameters for new modules creation\n - Vendor folder and vendor metadata automatic creation\n - Standard module folders structure creation\n - Completely filled module medatada file generation\n - Naming based on vendor data and module name\n - Created modules follow OXID standards\n - Automatic creation of pre-filled README file\n - Generation of PHP files comments with all vendor and module data\n - Main module class is included in each generated module\n    - It contains activation/deactivation events\n    - Support automatic SQL execution on the events\n    - The class \"knows\" about its module and provides useful methods\n - Generation of skeleton files for...\n    - Overloaded (extend) classes\n    - New controllers (also templates are created)\n    - Model classes\n    - List model classes (linked with item model classes)\n    - Widgets (also with templates)\n - Smarty blocks metadata and templates generation\n - Module settings metadata and translations generation\n - Translation files creation \n - Module version\n - Automatic checkout of tests folder\n    - And generation of pre-filled tests classes for each new module class\n    - Configurable GIT repository URL to get tests folder from\n - Learning mode\n    - Creation of hints and to do tasks inside generated files to help proceed with development\n    - Sample source code generation to give a hint what each class could/should contain\n - Generated module is immediately working\n    - Activate it and events, settings, blocks, controllers, etc. will already be in action! \n\n## Installation\n - Copy the content of `copy_this/` folder to OXID eShop root folder\n - Activate the module in administration area\n - Set eShop `modules/` folder writable while generating new modules\n\n## Usage\n - Make sure eShop `modules/` folder (and also Your vendor sub-folder, if it exists) is writable\n - Log in to eShop administration area\n - (for first run) Go to _Extensions -\u003e Modules -\u003e OXID Module Skeleton Generator -\u003e Settings -\u003e Vendor and Copyright Settings_ and enter Your vendor, copyright and author data\n - Open _Module Generator -\u003e Wizard_ (refresh page if it did not appear after module activation)\n - Enter a name for a new module in \"UpperCamelCase\" format, e.g. \"MyModule\"\n - (optionally) Enter any other options required in a new module (refer to help hints for more info)\n - Press \"Generate New Module\" button\n - The module skeleton source is now available in Your vendor sub-folder\n - And the module could be activated already in _Extensions -\u003e Modules_\n\n## To do and nice to have features for future releases\n - Refactor longer classes to move some methods elsewhere\n - Extend blocks definition validation and blocks templates naming\n - EDIT mode feature: for existing modules, generate/add extra stuff\n - Create nice looking generation form with JS/AJAX events to validate and help enter proper values (auto-complete)\n - Admin interface presets generation, also with menu.xml\n - Generate picture with PNG text overlay with real module name\n - PHPStorm style schemes (or some code beautifier) integration - after generation do code formatting\n - Copy not all folders, but only required ones (Refactor copyDir by providing \"copy scenario\" array)\n - dbEvent fail on multi-shops and multi-lang in real life projects - need PHP based DB installation\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fmodule_skeleton_generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxid-esales%2Fmodule_skeleton_generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fmodule_skeleton_generator/lists"}