https://github.com/eea/eea.api.controlpanel

https://github.com/eea/eea.api.controlpanel

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/eea/eea.api.controlpanel
• Owner: eea
• Created: 2024-03-15T08:46:28.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-03-18T13:06:57.000Z (10 months ago)
• Last Synced: 2024-11-04T12:23:22.211Z (2 months ago)
• Language: Python
• Size: 29.3 KB
• Stars: 0
• Watchers: 26
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-volto - eea.api.controlpanel - Backend add-on to be used with `volto-controlpanel` (Addons / Plone backend add-ons for Volto)

README

        
==========================

eea.api.controlpanel

==========================

.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/develop

  :target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/develop/display/redirect

  :alt: Develop

.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/master

  :target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/master/display/redirect

  :alt: Master

The eea.api.controlpanel is a Plone add-on to be used together

with `volto-controlpanel `_ Volto add-on

.. contents::

Main features

=============

1. Easy to install/uninstall via Site Setup > Add-ons

2. RestAPI for controlpanel versions details

Environment variables

=====================

- `BACKEND_VERSION` - Backend version to be saved to registry when Plone instance starts. You should update this environment variable every time you deploy a new version of your backend. 

Install

=======

* Add eea.api.controlpanel to your eggs section in your buildout and re-run buildout::

    [buildout]

    eggs +=

      eea.api.controlpanel

* Or via docker::

    $ docker compose up plone6

* Or via pip::

    $ pip install eea.api.controlpanel

* Install *eea.api.controlpanel* within Site Setup > Add-ons

Develop

=======

::

    $ git clone https://github.com/eea/eea.api.controlpanel.git

    $ cd eea.api.controlpanel

    $ git checkout develop

    $ make help

Source code

===========

- `Github `_

Eggs repository

===============

- https://pypi.python.org/pypi/eea.api.controlpanel

- http://eggrepo.eea.europa.eu/simple

Plone versions

==============

It has been developed and tested for Plone 5 and 6. It should work on any Plone version that supports Volto.

How to contribute

=================

See the `contribution guidelines (CONTRIBUTING.md) `_.

Copyright and license

=====================

eea.api.controlpanel (the Original Code) is free software; you can

redistribute it and/or modify it under the terms of the

GNU General Public License as published by the Free Software Foundation;

either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY

or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License

for more details.

You should have received a copy of the GNU General Public License along

with this program; if not, write to the Free Software Foundation, Inc., 59

Temple Place, Suite 330, Boston, MA 02111-1307 USA.

The Initial Owner of the Original Code is European Environment Agency (EEA).

Portions created by Eau de Web are Copyright (C) 2009 by

European Environment Agency. All Rights Reserved.

Funding

=======

EEA_ - European Environment Agency (EU)

.. _EEA: https://www.eea.europa.eu/

.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1