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.48.0 (2023-05-26)

Adds

• For performance, add apos.modules['piece-type']getManagerApiProjection method to reduce the amount of data returned in the manager modal. The projection will contain the fields returned in the method in addition to the existing manager modal columns.
• Add apos.schema.getRelationshipQueryBuilderChoicesProjection method to set the projection used in apos.schema.relationshipQueryBuilderChoices.
• Rich-text inline images now copies the alt attribute from the original image from the Media Library.

Changes

• Remove stripPlaceholderBrs and restorePlaceholderBrs from AposRichTextWidgetEditor.vue component.
• Change tiptap Gapcursor display to use a vertical blinking cursor instead of an horizontal cursor, which allow users to add text before and after inline images and tables.
• You can set max-width on .apos-rich-text-toolbar__inner to define the width of the rich-text toolbar. It will now flow on multiple lines if needed.
• The utilityRail prop of AposSchema now defaults to false, removing the need to explicitly pass it in almost all contexts.
• Mark apos.modules['doc-type'] methods getAutocompleteTitle, getAutocompleteProjection and autocomplete as deprecated. Our admin UI does not use them, it uses the autocomplete('...') query builder. More info at https://v3.docs.apostrophecms.org/reference/query-builders.html#autocomplete'.
• Print a warning with a clear explanation if a module's index.js file contains no module.exports object (often due to a typo), or it is empty.

Fixes

• Now errors and exits when a piece-type or widget-type module has a field object with the property type. Thanks to NuktukDev for this contribution.
• Add a default page type value to prevent the dropdown from containing an empty value.