Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-listing-block

Volto Listing Block Enhanced
https://github.com/eea/volto-listing-block

Last synced: 3 months ago
JSON representation

Volto Listing Block Enhanced

Host: GitHub
URL: https://github.com/eea/volto-listing-block
Owner: eea
License: mit
Created: 2021-05-17T10:26:10.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-05-22T12:21:36.000Z (6 months ago)
Last Synced: 2024-05-22T13:38:45.700Z (6 months ago)
Language: JavaScript
Size: 842 KB
Stars: 0
Watchers: 28
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-listing-block - Extension for the Volto listing block adding more templates (Addons / Layout addons)

README

        # volto-listing-block

[![Releases](https://img.shields.io/github/v/release/eea/volto-listing-block)](https://github.com/eea/volto-listing-block/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-listing-block%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-listing-block/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-listing-block%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-listing-block/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-listing-block-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-listing-block-develop)

[Volto](https://github.com/plone/volto) add-on

## Features

This package aims to provide a framework for more flexible listings for the

Listing Volto block. It introduces the concept of UniversalCard, which is a

generic component governed by a designated "itemModel".

It provides several views and integrates with the Teaser Grid.

![Listing Block](https://raw.githubusercontent.com/eea/volto-listing-block/master/docs/volto-listing-block.gif)

## Upgrade

### Upgrading to 1.x

This version requires: `@plone/volto >= 16.0.0.alpha.15` (`volto-slate` part of Volto Core).

## Getting started

### Try volto-listing-block with Docker

      git clone https://github.com/eea/volto-listing-block.git

      cd volto-listing-block

      make

      make start

Go to http://localhost:3000

### Add volto-listing-block to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

* If you already have a volto project, just update `package.json`:

   ```JSON

   "addons": [

       "@eeacms/volto-listing-block"

   ],

   "dependencies": {

       "@eeacms/volto-listing-block": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-listing-block

   cd my-volto-project

   ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-listing-block/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-listing-block/blob/master/DEVELOP.md).

## Copyright and license

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

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-listing-block/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)