https://github.com/plonegovbr/volto-twitter-block

Addon implementing Twitter blocks to Plone projects with Volto.
https://github.com/plonegovbr/volto-twitter-block

plone volto volto-addon volto-block

Last synced: 2 months ago
JSON representation

Addon implementing Twitter blocks to Plone projects with Volto.

• Host: GitHub
• URL: https://github.com/plonegovbr/volto-twitter-block
• Owner: plonegovbr
• License: mit
• Created: 2022-07-15T14:21:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-15T20:55:19.000Z (over 2 years ago)
• Last Synced: 2024-05-11T05:41:24.846Z (8 months ago)
• Topics: plone, volto, volto-addon, volto-block
• Language: JavaScript
• Homepage: https://plonegovbr.github.io/volto-twitter-block/
• Size: 10.5 MB
• Stars: 1
• Watchers: 16
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-volto - volto-twitter-block - Embed Tweets into Volto pages. (Addons)

README

        
# Twitter Blocks for Volto (@plonegovbr/volto-twitter-block)

Addon implementing Twitter blocks to [Plone](https://plone.org) projects with [Volto](https://github.com/plone/volto).

[![npm](https://img.shields.io/npm/v/@plonegovbr/volto-twitter-block)](https://www.npmjs.com/package/@plonegovbr/volto-twitter-block)

[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook&logoColor=white&style=flat-square)](https://plonegovbr.github.io/volto-twitter-block/)

[![Code analysis checks](https://github.com/plonegovbr/volto-twitter-block/actions/workflows/code.yml/badge.svg)](https://github.com/plonegovbr/volto-twitter-block/actions/workflows/code.yml)

[![Unit tests](https://github.com/plonegovbr/volto-twitter-block/actions/workflows/unit.yml/badge.svg)](https://github.com/plonegovbr/volto-twitter-block/actions/workflows/unit.yml)

## Screenshots

### Tweet Block Variations



### Tweet Block Alignment



### Tweet Block Editing



## Examples

@plonegovbr/volto-twitter-block can be seen in action at the following sites:

- [Plone Brasil](https://plone.org.br)

You can also check its [Storybook](https://plonegovbr.github.io/volto-twitter-block/).

## Install

### New Volto Project

Create a Volto project

```shell

npm install -g yo @plone/generator-volto

yo @plone/volto my-volto-project --addon @plonegovbr/volto-twitter-block

cd my-volto-project

```

Install new add-on and restart Volto:

```shell

yarn install

yarn start

```

### Existing Volto Project

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

```JSON

"addons": [

    "@plonegovbr/volto-twitter-block"

],

"dependencies": {

    "@plonegovbr/volto-twitter-block": "*"

}

```

### Integration with [@kitconcept/volto-blocks-grid](https://github.com/kitconcept/volto-blocks-grid)

If you already have a Volto project, just update `package.json` and make sure `@kitconcept/volto-blocks-grid` is listed before `@plonegovbr/volto-twitter-block` in **addons**:

```JSON

"addons": [

    "@kitconcept/volto-blocks-grid",

    "@plonegovbr/volto-twitter-block"

],

"dependencies": {

    "@kitconcept/volto-blocks-grid": "*",

    "@plonegovbr/volto-twitter-block": "*"

}

```

### Test it

Go to http://localhost:3000/

## Credits

The development of this add on was sponsored by the Brazilian Plone Community

[![PloneGov-Br](docs/plonegovbr.png)](https://plone.org.br/)