{"id":19176617,"url":"https://github.com/sulu/suluarticlebundle","last_synced_at":"2025-05-15T14:07:57.395Z","repository":{"id":37821045,"uuid":"61883398","full_name":"sulu/SuluArticleBundle","owner":"sulu","description":"Bundle for managing localized content-rich entities like blog-posts in the Sulu content management system","archived":false,"fork":false,"pushed_at":"2025-02-18T14:04:51.000Z","size":2118,"stargazers_count":63,"open_issues_count":42,"forks_count":79,"subscribers_count":13,"default_branch":"2.6","last_synced_at":"2025-05-15T14:07:39.022Z","etag":null,"topics":["article","hacktoberfest","php","sulu","sulu-bundle"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sulu.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-24T12:35:18.000Z","updated_at":"2025-05-13T13:12:41.000Z","dependencies_parsed_at":"2024-01-10T17:03:18.433Z","dependency_job_id":"e839715c-9360-43e2-abbf-43433b731d82","html_url":"https://github.com/sulu/SuluArticleBundle","commit_stats":{"total_commits":509,"total_committers":55,"mean_commits":9.254545454545454,"dds":0.693516699410609,"last_synced_commit":"5c8226f0825be95b58c281caffbe0d73aa3978c5"},"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluArticleBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluArticleBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluArticleBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluArticleBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sulu","download_url":"https://codeload.github.com/sulu/SuluArticleBundle/tar.gz/refs/heads/2.6","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355335,"owners_count":22057354,"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":["article","hacktoberfest","php","sulu","sulu-bundle"],"created_at":"2024-11-09T10:29:16.941Z","updated_at":"2025-05-15T14:07:52.377Z","avatar_url":"https://github.com/sulu.png","language":"PHP","readme":"\u003ch1 align=\"center\"\u003eSuluArticleBundle\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://sulu.io/\" target=\"_blank\"\u003e\n        \u003cimg width=\"30%\" src=\"https://sulu.io/uploads/media/800x/00/230-Official%20Bundle%20Seal.svg?v=2-6\u0026inline=1\" alt=\"Official Sulu Bundle Badge\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"LICENSE\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/sulu/SuluArticleBundle.svg\" alt=\"GitHub license\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/SuluArticleBundle/releases\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/tag/sulu/SuluArticleBundle.svg\" alt=\"GitHub tag (latest SemVer)\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/SuluArticleBundle/actions\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/sulu/SuluArticleBundle/test-application.yaml\" alt=\"Test workflow status\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://app.circleci.com/pipelines/github/sulu/SuluArticleBundle\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/circleci/build/github/sulu/SuluArticleBundle.svg?label=circleci\" alt=\"CircleCI build\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/sulu/releases\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/sulu%20compatibility-%3E=2.0-52b6ca.svg\" alt=\"Sulu compatibility\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\nThe **SuluArticleBundle** integrates a performance optimized way for managing articles in the [Sulu](https://sulu.io/)\ncontent management system. In the context of this bundle, **articles are localized content-rich entities** that are\n**manageable via the Sulu administration interface** and can be **rendered on a website delivered by Sulu**.\nThis makes them a good choice for managing things like blog posts, products or even recipes in a Sulu project.\nIn order to keep things clean, the bundle allows to **manage different types of articles via separated lists** in the\nadministration interface.\n\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"80%\" src=\"https://sulu.io/uploads/media/800x@2x/05/235-ezgif.gif?v=1\" alt=\"Sulu Slideshow\"\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\nThe SuluArticleBundle is compatible with Sulu **starting from version 2.0**. Have a look at the `require` section in\nthe [composer.json](composer.json) to find an\n**up-to-date list of the requirements** of the bundle.\n\n\n## 🚀\u0026nbsp; Installation and Documentation\n\nExecute the following [composer](https://getcomposer.org/) commands to add the bundle to the dependencies of your\nproject:\n\n```bash\ncomposer require \"elasticsearch/elasticsearch:7.17.*\" # should match version of your elasticsearch installation\ncomposer require sulu/article-bundle\n```\n\nAfterwards, visit the [bundle documentation](Resources/doc) to\nfind out **how to set up and configure the SuluArticleBundle** to your specific needs.\n\n\n## 💡\u0026nbsp; Key Concepts\n\n### Article Characteristics\n\nLike Sulu pages, articles are **configured via templates** and can include additional **SEO and excerpt information**.\nMoreover, articles support the same **drafting, publishing and versioning functionality** as provided by pages.\nIn contrast to Sulu pages, articles are **managed in a flat list** instead of a tree structure. Furthermore, unlike\nthe Sulu page tree, the article bundle is **optimized for managing a big number of articles**.\n\n\n### Elasticsearch dependency\n\nThe SuluArticleBundle was originally developed to be used in the publishing industry. To satisfy the initial\nrequirements regarding performance and scalability, a **view layer stored in an Elasticsearch index** was utilized.\nBecause of this, there is **no way to use the bundle without Elasticsearch** at the moment. It is planned to\nremove this hard dependency in the next major version.\n\nIf you cannot or do not want to make Elasticsearch a dependency of your project, you can **use Sulu pages for\ncertain use cases** instead of the SuluArticleBundle. However, be aware that the article list provides a better\nperformance and is more comfortable to use with a large number of entities.\n\n\n## ❤️\u0026nbsp; Support and Contributions\n\nThe Sulu content management system is a **community-driven open source project** backed by various partner companies.\nWe are committed to a fully transparent development process and **highly appreciate any contributions**.\n\nIn case you have questions, we are happy to welcome you in our official [Slack channel](https://sulu.io/services-and-support).\nIf you found a bug or miss a specific feature, feel free to **file a new issue** with a respective title and description\non the the [sulu/SuluArticleBundle](https://github.com/sulu/SuluArticleBundle) repository.\n\n\n## 📘\u0026nbsp; License\n\nThe Sulu content management system is released under the under terms of the [MIT License](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsuluarticlebundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsulu%2Fsuluarticlebundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsuluarticlebundle/lists"}