gcube-cms-suite/README.md

105 lines
5.0 KiB
Markdown
Raw Normal View History

2021-09-20 16:47:35 +02:00
gCube CMS Suite
--------------------------------------------------
2022-07-05 18:16:17 +02:00
gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here](https://sublime-and-sphinx-guide.readthedocs.io)
2022-07-05 17:22:22 +02:00
2024-02-28 16:15:38 +01:00
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/e/e4/Geo_Portale%281%29.png">](https://geoportal.cloud.d4science.org/geoportal-service/docs/index.html)
2022-07-05 17:22:22 +02:00
Rationale :
Publication involves lots of common features as well as custom behaviour and formats. The service implements the basic common logic, delegating to installed plugin both custom and configurable functions ranging from validation, data manifestation, indexing and lifecycle management.
**Lifecycle management** is itself an extension allowing for both common and complex ad-hoc workflows.
**High modularity of plugins** allows for the composition of ad hoc use cases with maximized re-usability.
2022-07-05 17:22:22 +02:00
2022-07-06 11:14:10 +02:00
The suite comes with a set of pre-built plugins and GUIs that communities can easily extend and / or reuse.
2022-07-05 17:22:22 +02:00
## Built with
* [gCube SmartGears](https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework
* [OpenJDK](https://openjdk.java.net/) - The JDK used
* [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services
* [Jersey](https://jersey.github.io/) - JAX-RS runtime
* [Maven](https://maven.apache.org/) - Dependency Management
* [Enunciate](http://enunciate.webcohesion.com/) - API Documentation
2024-02-28 16:15:38 +01:00
## General Architecture
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/c/ce/Geoportal_General_Architecture.jpg">](https://geoportal.cloud.d4science.org/geoportal-service/docs/architecture.html)
## Lifecycle Managements
Document Lifecycle Managements in action:
##### Single Step (no moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/8/8c/SingleStep_LC.png" style="max-width:600px;" alt="Default Single Step lifecycle">
##### 3 Phases (content moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/d/d8/Default3Phases_LC.png" style="max-width:750px;" alt="Default 3 Phases lifecycle">
## Plugins
Plugins in action:
* [Lifecycle Manager](/gCubeSystem/gcube-cms-suite/src/branch/master/default-lc-managers)
* [Spatial Data Infrastructure "SDI"](/gCubeSystem/gcube-cms-suite/src/branch/master/sdi-plugins)
* [Notifications](/gCubeSystem/gcube-cms-suite/src/branch/master/notifications-plugins)
* [Catalogue Binding](/gCubeSystem/gcube-cms-suite/src/branch/event_manager/catalogue-binding-plugin)
2023-11-10 10:03:54 +01:00
## Use Case
##### The D4GNA
2023-11-10 10:03:54 +01:00
["Dataset per il Geoportale Nazionale per lArcheologia"](https://gna.d4science.org)
Component diagram:
2022-07-05 17:22:22 +02:00
<img src="https://gcube.wiki.gcube-system.org/images_gcube/2/2e/Geoportal-Service_Workflow_and_Interactions_with_Engines.png" style="max-width:800px;" alt="D4GNA context: engines involved">
2022-07-05 17:22:22 +02:00
## Documentation
2023-07-08 18:47:33 +02:00
* [Dedicated Wiki](https://geoportal.d4science.org/geoportal-service/docs/index.html#) - powered by [Sphynx](https://www.sphinx-doc.org/en/master/)
* [Service Interactive API](https://geoportal.d4science.org/geoportal-service/api-docs/index.html) - powered by [Enunciate](http://enunciate.webcohesion.com/)
2022-07-05 17:24:52 +02:00
* [Gcube System Wiki](https://gcube.wiki.gcube-system.org/gcube/GeoPortal).
2023-07-10 10:41:43 +02:00
* [Guide Notebooks](use-cases) - powered by [Jupyter](https://jupyter.org/)
2022-07-05 17:22:22 +02:00
2021-09-20 16:47:35 +02:00
## Change log
See [CHANGELOG.md](CHANGELOG.md).
2023-07-08 18:47:33 +02:00
## Authors
* **Fabio Sinibaldi** as "Architect", "Developer" ([ORCID](https://orcid.org/0000-0003-1013-6203)) Computer Scientist at ISTI-CNR
2023-07-08 18:47:33 +02:00
* **Francesco Mangiacrapa** as "Architect", "Developer" and "Maintainer" ([ORCID](https://orcid.org/0000-0002-6528-664X)) Computer Scientist at [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
2023-07-08 18:47:33 +02:00
2021-09-20 16:47:35 +02:00
## License
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.
## About the gCube Framework
This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an
open-source software toolkit used for building and operating Hybrid Data
Infrastructures enabling the dynamic deployment of Virtual Research Environments
by favouring the realisation of reuse oriented policies.
The projects leading to this software have received funding from a series of European Union programmes including:
- the Sixth Framework Programme for Research and Technological Development
- DILIGENT (grant no. 004260).
- the Seventh Framework Programme for research, technological development and demonstration
- D4Science (grant no. 212488);
- D4Science-II (grant no.239019);
- ENVRI (grant no. 283465);
- iMarine(grant no. 283644);
- EUBrazilOpenBio (grant no. 288754).
- the H2020 research and innovation programme
- SoBigData (grant no. 654024);
- PARTHENOS (grant no. 654119);
- EGIEngage (grant no. 654142);
- ENVRIplus (grant no. 654182);
- BlueBRIDGE (grant no. 675680);
- PerformFish (grant no. 727610);
- AGINFRAplus (grant no. 731001);
- DESIRA (grant no. 818194);
- ARIADNEplus (grant no. 823914);
- RISIS2 (grant no. 824091);
2021-09-20 16:04:40 +02:00