feat(entity-feedback): implement plugin

Signed-off-by: Phil Kuang <pkuang@factset.com>
2023-01-19 15:00:48 -05:00
parent 3efd4da23c
commit a3c86a7ed2
69 changed files with 4381 additions and 3 deletions
@@ -0,0 +1,50 @@
+# Entity Feedback Backend
+
+Welcome to the entity-feedback backend plugin!
+
+## Installation
+
+### Install the package
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-entity-feedback-backend
+```
+
+### Adding the plugin to your `packages/backend`
+
+You'll need to add the plugin to the router in your `backend` package. You can do this by creating a file called `packages/backend/src/plugins/entityFeedback.ts`
+
+```tsx
+import { createRouter } from '@backstage/plugin-entity-feedback-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default function createPlugin(env: PluginEnvironment): Promise<Router> {
+  return createRouter({
+    database: env.database,
+    discovery: env.discovery,
+    identity: env.identity,
+    logger: env.logger,
+  });
+}
+```
+
+With the `entityFeedback.ts` router setup in place, add the router to `packages/backend/src/index.ts`:
+
+```diff
+import entityFeedback from './plugins/entityFeedback';
+
+async function main() {
+  ...
+  const createEnv = makeCreateEnv(config);
+
+  const catalogEnv = useHotMemoize(module, () => createEnv('catalog'));
+ const entityFeedbackEnv = useHotMemoize(module, () => createEnv('entityFeedback'));
+
+  const apiRouter = Router();
+ apiRouter.use('/entity-feedback', await entityFeedback(entityFeedbackEnv));
+  ...
+  apiRouter.use(notFoundHandler());
+
+```