This is the backend for the Announcements plugin. This plugin provides:
- REST APIs for managing announcements and categories
- Integration with the
@backstage/plugin-search
plugin - Integration with the
@backstage/plugin-permission-backend
plugin
Are you looking to install the announcements plugin? See the project's installation guide.
# install dependencies
yarn install
# start the backend
yarn start
The plugin includes a better-sqlite3 database seeded with categories and announcements.
With the backend running,
# runs migrations and seeds the database
yarn db:setup
This will create a local.sqlite
file under the db/
directory.
# run migrations
yarn db:migrations
# seed the database
yarn db:seed
Visit knexjs to learn more about the database migrations and seeding.
# get all announcements
curl http://localhost:7007/api/announcements/announcements
# get all categories
curl http://localhost:7007/api/categories
// get all announcements
const response = await fetch(
'http://localhost:7007/api/announcements/announcements',
);
const data = await response.json();
return data;