apostrophe

ApostropheCMS 3

ApostropheCMS is a full-featured, open source CMS built with Node.js that seeks to empower organizations by combining in-context editing and headless architecture in a full-stack JS environment.
Documentation »

Demo · Roadmap · Report Bug

About ApostropheCMS

ApostropheCMS is content software for everyone in an organization. It helps teams of all sizes create dynamic digital experiences with elegance and efficiency by blending powerful features, developer happiness, and a low learning curve for content creators. Apostrophe has powered websites and web apps for organizations large and small for over a decade.

Built With

• Node
• MongoDB
• Nunjucks

Getting Started

To get started with Apostrophe 3, follow these steps to set up a local development environment. For more detail, refer to the A3 getting started guide in the documentation.

Prerequisites

We recommend installing the following with Homebrew on macOS. If you're on Linux, you should use your package manager (apt or yum). If you're on Windows, we recommend the Windows Subsystem for Linux.

Software	Minimum Version	Notes
Node.js	12.x	Or better
npm	6.x	Or better
MongoDB	3.6	Or better
Imagemagick	Any	Faster image uploads, GIF support (optional)

Community

Discord - Twitter - Discussions

Contributing

We eagerly welcome open source contributions. Before submitting a PR, please read through our Contribution Guide

License

ApostropheCMS is released under the MIT License.

Changelog

3.54.0 (2023-08-16)

Adds

• Add @apostrophecms/log module to allow structured logging. All modules have logDebug, logInfo, logWarn and logError methods now. See the documentation for more details.
• Add @apostrophecms/settings translations.
• Add the ability to have custom modals for batch operations.
• Add the possibility to display utility operations inside a 3-dots menu on the page manager, the same way it is done for the docs manager.
• Custom context operations now accept a moduleIf property, which tests options at the module level the same way that if tests properties of the document to determine if the operation should be offered for a particular document. Note that not all options are passed to the front end unless getBrowserData is extended to suit the need.
• Move Pages Manager modal business logic to a mixin.
• Add column.extraWidth option (number) for AposTreeHeader.vue to allow control over the tree cell width.
• Move AposDocContextMenu.vue business logic to a mixin.
• Move Pages Manager modal business logic to a mixin. Add column.extraWidth option (number) for AposTreeHeader.vue to allow control over the tree cell width.

Changes

• Rename misleading projection parameter into options in self.find method signature for @apostrophecms/any-doc-type, @apostrophecms/any-page-type & @apostrophecms/piece-type. This was never really a projection in A3, so it is not a backwards compatibility issue.
• Hide save button during in-context editing if the document is autopublished.
• Beginning with this release, the correct moduleName for typical actions on the context document is automatically passed to the modal associated with a custom context operation, unless moduleName is explicitly specified. The moduleName parameter to addContextOperation is no longer required and should not be passed at all in most cases (just pass the object argument). If you do wish to specify a moduleName to override that prop given to the modal, then it is recommended to pass it as a moduleName property of the object, not as a separate argument. For backwards compatibility the two-argument syntax is still permitted.

Fixes

• Resolved data integrity issue with certain page tree operations by inferring the best peer to position the page relative to rather than attempting to remember the most recent move operation.
• Fixes a downstream bug in the getFieldsByCategory method in the AposEditorMixin.js by checking for a property before accessing it.
• In Nunjucks templates, data.url now includes any sitewide and locale URL prefixes. This fixes local prefixing for pagination of piece-type index pages.
• Changes were detected in various fields such as integers, which caused the "Update" button to be active even when there was no actual modification in the doc.
• Fix a bug that prevented adding multiple operations in the same batch operation group.
• The getTarget method of the page module should use findForEditing to make sure it is able to see pages that would be filtered out of a public view by project level or npm module overrides.