{"id":27771630,"url":"https://github.com/webreinvent/vaahcms-module-cms","last_synced_at":"2025-04-29T22:44:47.574Z","repository":{"id":37039676,"uuid":"188678539","full_name":"webreinvent/vaahcms-module-cms","owner":"webreinvent","description":"CMS module for VaahCMS Framework","archived":false,"fork":false,"pushed_at":"2025-03-29T05:47:34.000Z","size":14792,"stargazers_count":0,"open_issues_count":10,"forks_count":2,"subscribers_count":2,"default_branch":"2.x","last_synced_at":"2025-04-29T22:44:39.844Z","etag":null,"topics":["cms","cms-module","module","php","vaahcms","vue","vuejs","vuex"],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/webreinvent.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-26T12:12:48.000Z","updated_at":"2024-06-03T07:38:19.000Z","dependencies_parsed_at":"2023-11-20T10:27:15.687Z","dependency_job_id":"653e4783-cf6d-494b-96c6-80c15ab6bc31","html_url":"https://github.com/webreinvent/vaahcms-module-cms","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webreinvent%2Fvaahcms-module-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webreinvent%2Fvaahcms-module-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webreinvent%2Fvaahcms-module-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webreinvent%2Fvaahcms-module-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webreinvent","download_url":"https://codeload.github.com/webreinvent/vaahcms-module-cms/tar.gz/refs/heads/2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251596613,"owners_count":21615014,"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":["cms","cms-module","module","php","vaahcms","vue","vuejs","vuex"],"created_at":"2025-04-29T22:44:47.014Z","updated_at":"2025-04-29T22:44:47.562Z","avatar_url":"https://github.com/webreinvent.png","language":"PHP","readme":"# vaahcms-module-cms\nCms Module for VaahCMS\n\n#### New Version Release\n- Version should be updated in `composer.json` and `Config/config.php` file\n\n\n#### For Hot Reload add following:\n```dotenv\nMODULE_CMS_ENV=develop\n```\n\n#### Frontend Routes\n\n```php\n\n\u003cpublic-url\u003e/{permalink}\n\n\u003cpublic-url\u003e/{content_type}/{permalink}\n\n\u003cpublic-url\u003e/taxonomies/{taxonomy_type_slug}/{taxonomy_slug}\n\n\u003cpublic-url\u003e/search\n\n```\n\n## Helper Methods\n\n#### Theme Locations\n```blade\n{!! vh_location('top', true) !!}\n```\n\n#### Content\n```blade\n{!! get_content($data) !!}                      //   return HTML format\n\n{!! get_the_content($data) !!}                  //   return DATA format\n```\n\n```php\nget_content(Content $content, $type=null)\n\n$type = content/template;\n```\n\n#### Content List\n```blade\n{!! get_contents('page') !!}                      //   return HTML format\n\n{!! get_the_contents('page') !!}                  //   return DATA format\n```\n\n```php\nget_contents($content_type_slug='pages', array $args = null,$has_pagination = true)\n\n$args = [\n\n    'q'                         =\u003e 'search_item', \n    'per_page'                  =\u003e 5,                                       // default = 20\n    'include_groups'            =\u003e [],                                      // group_slug\n    'exclude_groups'            =\u003e [],                                      // group_slug   \n    'order'                     =\u003e 'name',                                  // default = id      \n    'order_by'                  =\u003e 'asc',                                   // default = desc      asc/desc/ASC/DESC\n    'container_opening_tag'     =\u003e '\u003cdiv class=\"columns is-multiline\"\u003e',\n    'container_closing_tag'     =\u003e '\u003c/div\u003e',\n    'content_opening_tag'       =\u003e '\u003cdiv class=\"column is-4\"\u003e',\n    'content_closing_tag'       =\u003e '\u003c/div\u003e'               \n\n];\n```\n\n#### Field\n```blade\n{!! get_field($data, 'title', 'default') !!}        //   return HTML format\n\n{!! get_the_field($data, 'title', 'default') !!}    //   return DATA format\n```\n\n```php\nget_field(Content $content, $field_slug,\n         $group_slug='default', $type='content',\n         $group_index = 0 , $field_index = null)\n\n$type = content/template;\n\n$group_index = 0/1/2/3/4/.....\n$field_index = 0/1/2/3/4/.....\n```\n\n#### Group\n```blade\n{!! get_group($data ,'default' ) !!}            //   return HTML format\n\n{!! get_the_group($data ,'default' ) !!}        //   return DATA format\n```\n\n```php\nget_group(Content $content, $group_slug='default', \n            $type='content, $group_index = null)\n\n$type = content/template;\n\n$group_index = 0/1/2/3/4/.....\n```\n\n## API\n\n#### Content\n```php\nparameter = [\n\n    'q'                         =\u003e 'search_item', \n    'per_page'                  =\u003e 5,                                       // default = 20\n    'include_groups'            =\u003e [],                                      // group_slug\n    'exclude_groups'            =\u003e [],                                      // group_slug\n    'order'                     =\u003e 'name',                                  // default = id      \n    'order_by'                  =\u003e 'asc',                                   // default = desc      asc/desc/ASC/DESC              \n\n];\n\n\u003cpublic-url\u003e/api/cms/contents/{plural_slug}\n```\n\n```php\n\u003cpublic-url\u003e/api/cms/contents/{singular_slug}/{content_slug}\n```\n\n#### Content Type\n```php\n\u003cpublic-url\u003e/api/cms/contents-types\n\n\u003cpublic-url\u003e/api/cms/contents-types/{slug}\n```\n\n\n#### To Run Modules Dusk Test:\n- Change path of dusk in `phpunit.dusk.xml` to following:\n```xml\n\n\u003cdirectory suffix=\"Test.php\"\u003e./VaahCms/Modules/Cms/Tests/Browser\u003c/directory\u003e\n\n```\n\n- Then run `php artisan dusk`\n\n\n\n\n### Change Log\n- Install `npm install auto-changelog -g`\n- To generate `CHANGELOG.md`, run `auto-changelog --commit-limit false` in the root folder of the project\n\nMaintain following pre-fixes to your commit messages:\n```md\nAdded:\nChanged:\nDeprecated:\nRemoved:\nFixed:\nSecurity:\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebreinvent%2Fvaahcms-module-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebreinvent%2Fvaahcms-module-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebreinvent%2Fvaahcms-module-cms/lists"}