https://github.com/K-Phoen/backstage-plugin-announcements

Announcements plugin for Backstage
https://github.com/K-Phoen/backstage-plugin-announcements

backstage backstage-plugin dx

Last synced: 4 months ago
JSON representation

Announcements plugin for Backstage

• Host: GitHub
• URL: https://github.com/K-Phoen/backstage-plugin-announcements
• Owner: K-Phoen
• License: mit
• Created: 2022-11-03T14:48:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-15T12:55:01.000Z (about 1 year ago)
• Last Synced: 2024-10-30T02:58:43.996Z (4 months ago)
• Topics: backstage, backstage-plugin, dx
• Language: TypeScript
• Homepage:
• Size: 3.04 MB
• Stars: 52
• Watchers: 3
• Forks: 30
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - K-Phoen/backstage-plugin-announcements - Announcements plugin for Backstage (others)

README

        
# Announcements plugin for Backstage

The Announcements plugin is a frontend, backend, and common plugin that manages and displays announcements within Backstage.

This plugin provides:

- a component to display the latest announcement as a banner, if there is one

- a component to display the latest announcements, for example on a homepage

- pages to list, view, create, edit and delete announcements

- integration with the [`@backstage/plugin-search`](https://github.com/backstage/backstage/tree/master/plugins/search) plugin

- integration with the [`@backstage/plugin-permission-backend`](https://github.com/backstage/backstage/tree/master/plugins/permission-backend) plugin

## Setup

Find [installation instructions](./docs/index.md#installation) in our documentation.

## How does it look?

Latest announcement banner:

![Latest announcement banner](./docs/images/announcement_banner.png)

Announcements card:

![Announcements card](./docs/images/announcements_card.png)

Announcements page:

![Announcements page](./docs/images/announcements_page.png)

Announcements search:

![Announcements search results](./docs/images/announcements_search.png)

## License

This library is under the [MIT](LICENSE) license.