{"id":13745864,"url":"https://github.com/magebitcom/vsf-aheadworks-blog","last_synced_at":"2025-12-27T01:59:29.966Z","repository":{"id":114258823,"uuid":"279896011","full_name":"magebitcom/vsf-aheadworks-blog","owner":"magebitcom","description":"Implement Aheadworks Blog extension in Vue Storefront!","archived":false,"fork":false,"pushed_at":"2020-11-17T14:00:44.000Z","size":63,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-22T17:32:16.810Z","etag":null,"topics":["aheadworks","blog","blogging","indexer","magebit","magento","vsf","vue-storefront","vue-storefront-api"],"latest_commit_sha":null,"homepage":"https://magebit.com","language":"Vue","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/magebitcom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-15T14:49:19.000Z","updated_at":"2023-09-11T20:30:15.000Z","dependencies_parsed_at":"2023-08-18T03:04:34.796Z","dependency_job_id":null,"html_url":"https://github.com/magebitcom/vsf-aheadworks-blog","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magebitcom%2Fvsf-aheadworks-blog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magebitcom%2Fvsf-aheadworks-blog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magebitcom%2Fvsf-aheadworks-blog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magebitcom%2Fvsf-aheadworks-blog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magebitcom","download_url":"https://codeload.github.com/magebitcom/vsf-aheadworks-blog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224834899,"owners_count":17377799,"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":["aheadworks","blog","blogging","indexer","magebit","magento","vsf","vue-storefront","vue-storefront-api"],"created_at":"2024-08-03T06:00:39.736Z","updated_at":"2025-12-27T01:59:29.957Z","avatar_url":"https://github.com/magebitcom.png","language":"Vue","funding_links":[],"categories":["Resources for Vue Storefront 1"],"sub_categories":["Official Resources - v1"],"readme":"# Aheadworks Blog for Vue Storefront\nImplement Aheadworks Blog extension in Vue Storefront! Comes with a sample layout that you can easiliy customize.\n\n## Table of contents\n* [Prerequisites](#prerequisites)\n* [Installation](#installation)\n  * [Magento 2 Indexer module](#magento-2-indexer-module)\n  * [Vue Storefront module](#vue-storefront-module)\n* [Example preview](#preview)\n* [Contributing](#contributing)\n  \n### Prerequisites\n* Magento 2 with [VSBridge Indexer](https://github.com/DivanteLtd/magento2-vsbridge-indexer) and [Aheadworks Blog](https://ecommerce.aheadworks.com/magento-2-extensions/blog) extension\n* **Vue Storefront v1.12** or greater\n* Vue Storefront default theme, but can be implemented with capybara, by editing our blog components.\n  \n## Installation\n\n#### Magento 2 Indexer module\nTo implement this module in your project, first you'll need to install our [Aheadworks Blog Indexer](https://github.com/magebitcom/vsf-aheadworks-blog-indexer) module for Magento 2 / VSBridge Indexer:\n  * Via composer - `composer require magebit/aheadworks-blog-indexer`\n  * For manual installation check the README here: https://github.com/magebitcom/vsf-aheadworks-blog-indexer\n  \n#### Vue Storefront module\n  * Clone this repository inside `src/modules/`\n    * `git clone git@github.com:magebitcom/vsf-aheadworks-blog.git ./src/modules/aheadworks-blog`\n  * Register the module in `src/client.ts`\n    ```js\n    import { AheadworksBlog } from './aheadworks-blog'\n    \n    export function registerClientModules () {\n      //...\n      \n      registerModule(AheadworksBlog)\n    }\n\n    ```\n  * Register Blog routes inside `src/themes/your-theme/router/index.js` \n    ```js\n    const BlogCategory = () =\u003e import(/* webpackChunkName: \"vsf-aheadworks-blog-category\" */ 'src/modules/aheadworks-blog/pages/BlogCategory.vue')\n    const BlogPost = () =\u003e import(/* webpackChunkName: \"vsf-aheadworks-blog-post\" */ 'src/modules/aheadworks-blog/pages/BlogPost.vue')\n    \n    let routes = [\n    // ...\n    { name: 'aheadworks-blog-category', path: '/blog/category/:slug', component: BlogCategory },\n    { name: 'aheadworks-blog-post', path: '/blog/:slug', component: BlogPost },\n    { name: 'aheadworks-blog', path: '/blog', component: BlogCategory },\n    // ...\n    ```\n  \n  * Update `publisher` field inside `src/modules/aheadworks-blog/pages/BlogPost.vue structuredData`\n  * Everything should be working by now, but you can also add blog entity types to your config:\n    ```json\n      \"entities\": {\n        \"blog_post\": {\n          \"includeFields\": [\n            \"id\",\n            \"title\",\n            \"url_key\",\n            \"blog_categories\",\n            \"blog_category_ids\",\n            \"author_name\",\n            \"publish_date\",\n            \"featured_image_file\",\n            \"featured_image_name\",\n            \"featured_image_alt\",\n            \"short_content\",\n            \"content\"\n          ]\n        },\n        \"blog_category\": {\n          \"includeFields\": [\n            \"id\",\n            \"name\",\n            \"url_key\",\n            \"description\",\n            \"image_file_name\",\n            \"image_alt\",\n            \"image_title\",\n            \"meta_description\",\n            \"meta_keywords\",\n            \"meta_prefix\",\n            \"meta_suffix\",\n            \"meta_title\",\n            \"sort_order\"\n          ]\n        },\n      }\n    ```\n## Preview\n![Category page](https://i.imgur.com/pxyoGyy.png)\n![Category page](https://i.imgur.com/cEh6juA.png)\n![Post page](https://i.imgur.com/CtWYApJ.png)\n\n## Contributing\nFound a bug, have a feature suggestion or just want to help in general?\nContributions are very welcome! Check out the [list of active issues](https://github.com/magebitcom/vsf-aheadworks-blog/issues) or submit one yourself.\n\nIf you're making a bug report, please include as much details as you can and preferably steps to repreduce the issue.\nWhen creating Pull Requests, don't for get to list your changes in the [CHANGELOG](/CHANGELOG.md) and [README](/README.md) files.\n\n---\n\n![Magebit](https://magebit.com/img/magebit-logo-2x.png)\n\n*Have questions or need help? Contact us at info@magebit.com*\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagebitcom%2Fvsf-aheadworks-blog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagebitcom%2Fvsf-aheadworks-blog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagebitcom%2Fvsf-aheadworks-blog/lists"}