add initial setup

Author: jonaslagoni

.github/workflows/deploy.yml

@@ -0,0 +1,81 @@
+name: Deploy EventCatalog to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./eventcatalog
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+          cache-dependency-path: './eventcatalog/yarn.lock'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Create .env file
+        run: |
+          cat << EOF > .env
+          EVENTCATALOG_SCALE_LICENSE_KEY=${{ secrets.EVENTCATALOG_SCALE_LICENSE_KEY }}
+          EVENTCATALOG_LICENSE_KEY_ASYNCAPI=${{ secrets.EVENTCATALOG_LICENSE_KEY_ASYNCAPI }}
+          EOF
+        shell: bash
+
+      - name: Generate EventCatalog files
+        run: yarn generate
+
+      - name: Build EventCatalog
+        run: yarn build
+        env:
+          NODE_ENV: production
+
+      - name: Export static files
+        run: yarn export || echo "No export command, using build output"
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './eventcatalog/dist'
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

eventcatalog/.env.template

@@ -0,0 +1,3 @@
+# Add license key from eventcatalog
+EVENTCATALOG_SCALE_LICENSE_KEY=123
+EVENTCATALOG_LICENSE_KEY_ASYNCAPI=123

eventcatalog/.gitignore

@@ -0,0 +1,4 @@
+.env
+node_modules
+.eventcatalog-core
+dist

eventcatalog/README.md

@@ -0,0 +1,29 @@
+# EventCatalog AsyncAPI Example
+
+This is an example project for EventCatalog with the AsyncAPI generator plugin.
+
+This example contains
+
+- Generating EventCatalog from AsyncAPI files
+- Mapping multiple AsyncAPI files into a domain
+- EventCatalog generated by AsyncAPI files
+
+### Getting Started
+
+1. Clone this project
+1. Run `npm install`
+1. Get and configure a AsyncAPI license key from [AsyncAPI](https://eventcatalog.cloud) (14 day free trial)
+1. Run the generators `npm run generate`
+1. Run the catalog `npm run dev`
+1. View your catalog at https://localhost:3000
+
+### Features for OpenAPI Plugin
+
+- Auto versioning of domains, services and messages
+- Document events, queries and commands using custom extensions to AsyncAPI
+- Assign each route/message a version independent of your AsyncAPI version
+- Visually see AsyncAPI files in your catalog.
+- And much more...
+
+To dive into how this plugin can help you, you can read the [AsyncAPI Plugin Docs](https://www.eventcatalog.dev/integrations/asyncapi)
+

eventcatalog/asyncapi-files/fraud-detection-service.yml

@@ -0,0 +1,141 @@
+asyncapi: 3.0.0
+info:
+  title: Fraud Detection Service
+  version: 1.0.1
+  description: This service monitors transactions to detect potentially fraudulent activities.
+
+operations:
+  sendFraudAlert:
+    action: send
+    channel:
+      $ref: '#/channels/fraudAlert'
+    messages:
+      - $ref: '#/channels/fraudAlert/messages/FraudAlert'
+
+  receiveTransactionEvaluated:
+    action: receive
+    channel:
+      $ref: '#/channels/transactionEvaluated'
+    messages:
+      - $ref: '#/channels/transactionEvaluated/messages/TransactionEvaluated'
+
+  receiveTransactionReview:
+    action: receive
+    channel:
+      $ref: '#/channels/transactionReview'
+    messages:
+      - $ref: '#/channels/transactionReview/messages/TransactionReview'
+
+channels:
+  fraudAlert:
+    address: fraud/alert
+    messages:
+      FraudAlert:
+        $ref: '#/components/messages/FraudAlert'
+
+  transactionEvaluated:
+    address: transaction/evaluated
+    messages:
+      TransactionEvaluated:
+        $ref: '#/components/messages/TransactionEvaluated'
+
+  transactionReview:
+    address: transaction/review
+    messages:
+      TransactionReview:
+        $ref: '#/components/messages/TransactionReview'
+
+components:
+  messages:
+    FraudAlert:
+      description: 'Fraud alert triggered by a suspicious transaction'
+      x-eventcatalog-message-type: event
+      tags:
+        - name: 'Fraud'
+          description: 'Fraud detection event'
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          alertId:
+            type: string
+            description: Unique identifier for the fraud alert
+          transactionId:
+            type: string
+            description: Unique identifier for the transaction
+          alertTime:
+            type: string
+            format: date-time
+            description: Time when the fraud alert was triggered
+          severity:
+            type: string
+            description: Severity level of the fraud alert
+          details:
+            type: string
+            description: Additional details about the fraud alert
+
+    TransactionEvaluated:
+      description: 'Evaluation results of a transaction for fraud risk'
+      x-eventcatalog-message-type: event
+      tags:
+        - name: 'Evaluation'
+          description: 'Transaction evaluation event'
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: event
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          transactionId:
+            type: string
+            description: Unique identifier for the transaction
+          evaluationTime:
+            type: string
+            format: date-time
+            description: Time when the transaction was evaluated
+          isFraudulent:
+            type: boolean
+            description: Indicates whether the transaction was flagged as fraudulent
+          riskScore:
+            type: number
+            description: Risk score assigned to the transaction
+
+    TransactionReview:
+      description: 'Manual review of a flagged transaction'
+      x-eventcatalog-message-type: command
+      tags:
+        - name: 'Review'
+          description: 'Transaction review command'
+      headers:
+        type: object
+        properties:
+          ec-message-type:
+            type: string
+            default: command
+            description: Type of message for EventCatalog
+      payload:
+        type: object
+        properties:
+          transactionId:
+            type: string
+            description: Unique identifier for the transaction
+          reviewTime:
+            type: string
+            format: date-time
+            description: Time when the transaction was reviewed
+          reviewOutcome:
+            type: string
+            description: Outcome of the manual review (e.g., Approved, Declined, Escalated)
+          reviewerId:
+            type: string
+            description: Identifier for the reviewer who conducted the review