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.53.0 (2023-08-03)

Adds

• Accessibility improved for navigation inside modals and various UI elements. Pages/Docs Manager and Doc Editor modal now have better keyboard accessibility. They keep the focus on elements inside modals and give it back to their parent modal when closed. This implementation is evolving and will likely switch to use the dialog HTML element soon.
• Adds support for a new if property in addContextOperation in order to show or not a context operation based on the current document properties.
• Add update-doc-fields event to call AposDocEditor.updateDocFields method
• Add schema field hidden property to always hide a field
• Hide empty schema tabs in AposDocEditor when all fields are hidden due to if conditions
• The front end UI now respects the _aposEditorModal and _aposAutopublish properties of a document if present, and otherwise falls back to module configuration. This is a powerful addition to custom editor components for piece and page types, allowing "virtual piece types" on the back end that deal with many content types to give better hints to the UI.
• Respect the _aposAutopublish property of a document if present, otherwise fall back to module configuration.
• For convenience in custom editor components, pass the new prop type, the original type of the document being copied or edited.
• For better results in custom editor components, pass the prop copyOfId, which implies the custom editor should fetch the original itself by its means of choice. For backwards compatibility copyOf is still passed, but it may be an incomplete projection and should not be used in new code.
• Custom context operations now receive a docId prop, which should be used in preference to doc because doc may be an incomplete projection.
• Those creating custom context operations for documents can now specify both a props object for additional properties to be passed to their modal and a docProps object to map properties from the document to props of their choosing.
• Adds support to add context labels in admin bar.
• Adds support for admin UI language configuration in the @apostrophecms/i18n module. The new options allow control over the default admin UI language and configures the list of languages, that any individual logged in user can choose from. See the documentation for more details.
• Adds adminLocale User field to allow users to set their preferred admin UI language, but only when the @apostrophecms/i18n is configured accordingly (see above).
• Adds @apostrophecms/settings module and a "Personal Settings" feature. See the documentation for more details.
• Adds $and operator on addContextOperation if property in order to check multiple fields before showing or hiding a context operation.

Fixes

• AposDocEditor onSave method signature. We now always expect an object when a parameter is passed to the function to check the value of navigate flag.
• Fixes a problem in the rich text editor where the slash would not be deleted after item selectin from the insert menu.
• Modules that have a public or i18n subdirectory no longer generate a warning if they export no code.
• Clean up focus parent event handlers when components are destroyed. Prevents a slow degradation of performance while editing. Thanks to Joshua N. Miller.
• Fixes a visual discrepancy in the rich text editor where empty paragraphs would appear smaller in preview mode compared to edit mode.

Changes

• To make life easier for module developers, modules that are npm linked to the project no longer have to be listed in package.json as dependencies. To prevent surprises this is still a requirement for modules that are not symlinked.