node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org ยป

@plone/restapi-angular

The Plone Angular SDK

Build Status Coverage Status

A simple Angular SDK to build web sites easily on top of the Plone RESTAPI.

This package aims to provide the services and components needed to build an Angular applications based on the Plone REST API.

Plone is a flexible and powerful backend, it provides:

  • hierachical storage
  • customizable content types
  • granular access control
  • workflows
  • a rich management interface

The Plone Angular SDK provides ready-to-use components to build a wide range of applications.

Animation

Documentation

See documentation folder.

Example

This repository contains a very simple example: https://github.com/collective/plone-angular-demo.

To initialize it, run:

yarn install

Make sure you have a Plone server running on localhost:8080 with Plone RESTAPI installed.

Then launch:

ng serve

and visit http://locahost:4200/.

By checking out this commit, you will get a site displaying the current content plus a navigation bar, with no customization.

If you checkout this commit, you will have bootstrap style (you will need to run yarn install in order to update your node modules) and a custom navigation.

Run tests

cd tests
yarn install
cd ..
yarn test

Contribute

Support

If you are having issues, please let us know.

Use thissue tracker https://github.com/plone/plone.restapi-angular/issues

License

The project is licensed under the MIT license.