Skip to content

plone/aurora

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7,199 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@plone/aurora

Unit Tests Acceptance Tests Build Status Docs

Introduction

Plone Aurora is a ReactJS-based frontend for the Plone Content Management System compatible with the plone.restapi specification.

Plone is a CMS built on Python with more than 25 years of history and experience.

Plone has features that appeal to developers and users alike, such as an intuitive editing interface, customizable content types, hierarchical organization, and a sophisticated permissions model. This allows you to build anything from simple websites to enterprise-grade intranets.

Plone Aurora exposes all these features and communicates with Plone via its REST API.

Plone Aurora features the Somersault editor, a modern block-based content layout editor based on Plate.js. It is extensible and customizable, so you can adapt the provided default blocks to meet your requirements, or build new ones.

Plone Aurora is extensible using add-ons.

Plone Aurora is the successor and natural evolution to the Plone Volto frontend.

Demo

You can try a Plone Aurora online demo at https://aurora.demo.plone.org/.

Monorepo structure

This repository has had the shape of a monorepo, where "mono" means "single" and "repo" is short for "repository". This means that several apps and libraries related to each other are stored in the same repository. They are managed together but released individually. This allows the code to be shared effectively, and unifies tracking of changes across all of the apps and libraries.

Package Location
@plone/client packages/client
@plone/components packages/components
@plone/registry packages/registry
@plone/types packages/types
@plone/helpers packages/helpers
@plone/react-router packages/react-router
@plone/blocks packages/blocks
@plone/layout packages/layout
@plone/publicui packages/publicui
@plone/cmsui packages/cmsui
@plone/contents packages/contents
@plone/plate packages/plate
@plone/agave packages/agave

See also Monorepo structure.

Storybook for the frontend's modular architecture

The frontend's modular architecture in Plone is documented with Storybook. You can find it at https://plone-storybook.readthedocs.io/?path=/docs/introduction--docs.

Create a Plone Aurora frontend-only project

To create a project with a frontend-only scaffold using Plone Aurora, follow the Plone installation documentation.

Documentation

You can find the documentation at https://volto.readthedocs.io/seven/.

Supported Plone, Python, and Plone REST API versions

See Plone, Python, and Plone REST API compatibility

See the Plone Release Schedule for details of maintenance and support.

Supported Node.js versions

See Node.js version policy.

Supported browsers

See Supported browsers.

Contributing

To contribute to the Plone Aurora project by writing code, documentation, translations, and so on, please read Contributing to Plone and Contributing to Volto.

For newcomers to Plone Aurora, Plone, or open source software, you must read and follow First-time contributors.

Contributors

License

MIT License. Copyrights held by the Plone Foundation.

See LICENSE.md for details.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors