feat: add event catalog and contracts (#4)

* feat: add example architecture contracts * feat: add event catalog * fix: change link to correct github repo
aleios-cloud · Aug 23, 2023 · b59f626 · b59f626
1 parent 6a3c9d3
commit b59f626
Show file tree

Hide file tree

Showing 9 changed files with 6,433 additions and 0 deletions.
diff --git a/event-catalog/eventcatalog.config.js b/event-catalog/eventcatalog.config.js
@@ -0,0 +1,43 @@
+module.exports = {
+  title: "EventCatalog",
+  tagline: "Discover, Explore and Document your Event Driven Architectures",
+  organizationName: "Your Company",
+  projectName: "Event Catalog",
+  editUrl:
+    "https://github.com/aleios-cloud/eventbridge-toolbox-schema-generator",
+  trailingSlash: true,
+  primaryCTA: {
+    label: "Explore Events",
+    href: "/events",
+  },
+  secondaryCTA: {
+    label: "Getting Started",
+    href: "https://www.eventcatalog.dev/",
+  },
+  logo: {
+    alt: "EventCatalog Logo",
+    // found in the public dir
+    src: "logo.svg",
+  },
+  footerLinks: [{ label: "Events", href: "/events" }],
+  users: [
+    {
+      id: "LukeY",
+      name: "Luke Yianni",
+      avatarUrl: "https://randomuser.me/api/portraits/lego/5.jpg",
+      role: "Architect",
+    },
+    {
+      id: "AprilB",
+      name: "April Bates",
+      avatarUrl: "https://randomuser.me/api/portraits/lego/9.jpg",
+      role: "Developer",
+    },
+    {
+      id: "RyanS",
+      name: "Ryan Schuller",
+      avatarUrl: "https://randomuser.me/api/portraits/lego/8.jpg",
+      role: "Developer",
+    },
+  ],
+};
diff --git a/event-catalog/events/PersonRegisteredContract/versioned/1/index.md b/event-catalog/events/PersonRegisteredContract/versioned/1/index.md
@@ -0,0 +1,20 @@
+---
+name: PersonRegisteredContract
+version: 1
+summary: |
+  A summary
+producers:
+  - Producer
+consumers:
+  - Consumer
+owners:
+  - Name
+---
+
+<Admonition>Some information</Admonition>
+
+### Details
+
+Some details...
+
+<Schema />
diff --git a/event-catalog/events/PersonRegisteredContract/versioned/1/schema.json b/event-catalog/events/PersonRegisteredContract/versioned/1/schema.json
@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "detail-type": {
+      "type": "string",
+      "const": "PersonRegisteredContract"
+    },
+    "detail": {
+      "type": "object",
+      "properties": {
+        "detail-version": {
+          "type": "number",
+          "const": 1
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "firstName": {
+              "type": "string"
+            },
+            "lastName": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "firstName",
+            "lastName"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "detail-version",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "detail",
+    "detail-type"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}
diff --git a/event-catalog/events/PersonRegisteredContract/versioned/2/index.md b/event-catalog/events/PersonRegisteredContract/versioned/2/index.md
@@ -0,0 +1,20 @@
+---
+name: PersonRegisteredContract
+version: 2
+summary: |
+  A summary
+producers:
+  - Producer
+consumers:
+  - Consumer
+owners:
+  - Name
+---
+
+<Admonition>Some information</Admonition>
+
+### Details
+
+Some details...
+
+<Schema />
diff --git a/event-catalog/events/PersonRegisteredContract/versioned/2/schema.json b/event-catalog/events/PersonRegisteredContract/versioned/2/schema.json
@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "detail-type": {
+      "type": "string",
+      "const": "PersonRegisteredContract"
+    },
+    "detail": {
+      "type": "object",
+      "properties": {
+        "detail-version": {
+          "type": "number",
+          "const": 2
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "firstName": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "firstName"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "detail-version",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "detail",
+    "detail-type"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}
diff --git a/event-catalog/package.json b/event-catalog/package.json
@@ -0,0 +1,24 @@
+{
+  "name": "event-catalog",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "start": "eventcatalog start",
+    "dev": "eventcatalog dev",
+    "build": "eventcatalog build",
+    "generate": "eventcatalog generate"
+  },
+  "devDependencies": {
+    "@eventcatalog/types": "0.4.2",
+    "@types/node": "20.4.9",
+    "@types/react": "18.2.19",
+    "autoprefixer": "10.4.5",
+    "cross-env": "^7.0.3",
+    "postcss": "^8.3.11",
+    "tailwindcss": "^2.2.19",
+    "typescript": "^4.4.4"
+  },
+  "dependencies": {
+    "@eventcatalog/core": "0.6.12"
+  }
+}