Skip to content

Commit b59f626

Browse files
authored
feat: add event catalog and contracts (#4)
* feat: add example architecture contracts * feat: add event catalog * fix: change link to correct github repo
1 parent 6a3c9d3 commit b59f626

File tree

9 files changed

+6433
-0
lines changed

9 files changed

+6433
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
module.exports = {
2+
title: "EventCatalog",
3+
tagline: "Discover, Explore and Document your Event Driven Architectures",
4+
organizationName: "Your Company",
5+
projectName: "Event Catalog",
6+
editUrl:
7+
"https://github.com/aleios-cloud/eventbridge-toolbox-schema-generator",
8+
trailingSlash: true,
9+
primaryCTA: {
10+
label: "Explore Events",
11+
href: "/events",
12+
},
13+
secondaryCTA: {
14+
label: "Getting Started",
15+
href: "https://www.eventcatalog.dev/",
16+
},
17+
logo: {
18+
alt: "EventCatalog Logo",
19+
// found in the public dir
20+
src: "logo.svg",
21+
},
22+
footerLinks: [{ label: "Events", href: "/events" }],
23+
users: [
24+
{
25+
id: "LukeY",
26+
name: "Luke Yianni",
27+
avatarUrl: "https://randomuser.me/api/portraits/lego/5.jpg",
28+
role: "Architect",
29+
},
30+
{
31+
id: "AprilB",
32+
name: "April Bates",
33+
avatarUrl: "https://randomuser.me/api/portraits/lego/9.jpg",
34+
role: "Developer",
35+
},
36+
{
37+
id: "RyanS",
38+
name: "Ryan Schuller",
39+
avatarUrl: "https://randomuser.me/api/portraits/lego/8.jpg",
40+
role: "Developer",
41+
},
42+
],
43+
};
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: PersonRegisteredContract
3+
version: 1
4+
summary: |
5+
A summary
6+
producers:
7+
- Producer
8+
consumers:
9+
- Consumer
10+
owners:
11+
- Name
12+
---
13+
14+
<Admonition>Some information</Admonition>
15+
16+
### Details
17+
18+
Some details...
19+
20+
<Schema />
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"type": "object",
4+
"properties": {
5+
"detail-type": {
6+
"type": "string",
7+
"const": "PersonRegisteredContract"
8+
},
9+
"detail": {
10+
"type": "object",
11+
"properties": {
12+
"detail-version": {
13+
"type": "number",
14+
"const": 1
15+
},
16+
"data": {
17+
"type": "object",
18+
"properties": {
19+
"firstName": {
20+
"type": "string"
21+
},
22+
"lastName": {
23+
"type": "string"
24+
}
25+
},
26+
"required": [
27+
"firstName",
28+
"lastName"
29+
],
30+
"additionalProperties": false
31+
}
32+
},
33+
"required": [
34+
"detail-version",
35+
"data"
36+
],
37+
"additionalProperties": false
38+
}
39+
},
40+
"required": [
41+
"detail",
42+
"detail-type"
43+
],
44+
"additionalProperties": false,
45+
"definitions": {}
46+
}
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: PersonRegisteredContract
3+
version: 2
4+
summary: |
5+
A summary
6+
producers:
7+
- Producer
8+
consumers:
9+
- Consumer
10+
owners:
11+
- Name
12+
---
13+
14+
<Admonition>Some information</Admonition>
15+
16+
### Details
17+
18+
Some details...
19+
20+
<Schema />
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"type": "object",
4+
"properties": {
5+
"detail-type": {
6+
"type": "string",
7+
"const": "PersonRegisteredContract"
8+
},
9+
"detail": {
10+
"type": "object",
11+
"properties": {
12+
"detail-version": {
13+
"type": "number",
14+
"const": 2
15+
},
16+
"data": {
17+
"type": "object",
18+
"properties": {
19+
"firstName": {
20+
"type": "string"
21+
}
22+
},
23+
"required": [
24+
"firstName"
25+
],
26+
"additionalProperties": false
27+
}
28+
},
29+
"required": [
30+
"detail-version",
31+
"data"
32+
],
33+
"additionalProperties": false
34+
}
35+
},
36+
"required": [
37+
"detail",
38+
"detail-type"
39+
],
40+
"additionalProperties": false,
41+
"definitions": {}
42+
}

event-catalog/package.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "event-catalog",
3+
"version": "0.0.1",
4+
"private": true,
5+
"scripts": {
6+
"start": "eventcatalog start",
7+
"dev": "eventcatalog dev",
8+
"build": "eventcatalog build",
9+
"generate": "eventcatalog generate"
10+
},
11+
"devDependencies": {
12+
"@eventcatalog/types": "0.4.2",
13+
"@types/node": "20.4.9",
14+
"@types/react": "18.2.19",
15+
"autoprefixer": "10.4.5",
16+
"cross-env": "^7.0.3",
17+
"postcss": "^8.3.11",
18+
"tailwindcss": "^2.2.19",
19+
"typescript": "^4.4.4"
20+
},
21+
"dependencies": {
22+
"@eventcatalog/core": "0.6.12"
23+
}
24+
}

0 commit comments

Comments
 (0)