@eventcatalog/create-eventcatalog 3.0.5 → 3.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +4 -1
- package/package.json +1 -1
- package/templates/confluent/Dockerfile +23 -0
- package/templates/confluent/Dockerfile.server +23 -0
- package/templates/confluent/README-template.md +4 -0
- package/templates/confluent/dockerignore +8 -0
- package/templates/confluent/env +7 -0
- package/templates/confluent/eventcatalog.config.js +45 -0
- package/templates/confluent/eventcatalog.styles.css +1 -0
- package/templates/confluent/gitignore +27 -0
- package/templates/confluent/npmrc +1 -0
- package/templates/confluent/public/logo.png +0 -0
- package/templates/index.ts +4 -0
- package/templates/types.ts +1 -1
package/dist/index.js
CHANGED
|
@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
|
|
|
22466
22466
|
var package_default = {
|
|
22467
22467
|
name: "@eventcatalog/create-eventcatalog",
|
|
22468
22468
|
description: "Create EventCatalog with one command",
|
|
22469
|
-
version: "3.0.
|
|
22469
|
+
version: "3.0.6",
|
|
22470
22470
|
bin: {
|
|
22471
22471
|
"create-catalog": "./dist/index.js"
|
|
22472
22472
|
},
|
|
@@ -22582,6 +22582,9 @@ var installTemplate = async ({
|
|
|
22582
22582
|
if (template === "openapi") {
|
|
22583
22583
|
dependencies.push("@eventcatalog/generator-openapi");
|
|
22584
22584
|
}
|
|
22585
|
+
if (template === "confluent") {
|
|
22586
|
+
dependencies.push("@eventcatalog/generator-confluent-schema-registry");
|
|
22587
|
+
}
|
|
22585
22588
|
const devDependencies = [];
|
|
22586
22589
|
if (dependencies.length) {
|
|
22587
22590
|
console.log();
|
package/package.json
CHANGED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
## Stage 1: Build the app
|
|
2
|
+
FROM node:lts AS build
|
|
3
|
+
|
|
4
|
+
WORKDIR /app
|
|
5
|
+
|
|
6
|
+
# Install dependencies
|
|
7
|
+
COPY package.json package-lock.json ./
|
|
8
|
+
RUN npm install
|
|
9
|
+
|
|
10
|
+
# Copy source code
|
|
11
|
+
COPY . .
|
|
12
|
+
|
|
13
|
+
# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
|
|
14
|
+
ENV NODE_OPTIONS=--max_old_space_size=2048
|
|
15
|
+
# Build the app
|
|
16
|
+
RUN npm run build
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Stage 2: Serve app with httpd server
|
|
20
|
+
FROM httpd:2.4
|
|
21
|
+
|
|
22
|
+
# Copy built app to serve
|
|
23
|
+
COPY --from=build /app/dist /usr/local/apache2/htdocs
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Use this Docker file if your EventCatalog output is set to `server`.
|
|
2
|
+
# When EventCatalog output is set to `server`, the output will be a node server.
|
|
3
|
+
# This server is required for certain features like the EventCatalog Chat (with your own keys).
|
|
4
|
+
|
|
5
|
+
FROM node:lts AS runtime
|
|
6
|
+
WORKDIR /app
|
|
7
|
+
|
|
8
|
+
# Install dependencies
|
|
9
|
+
COPY package.json package-lock.json ./
|
|
10
|
+
RUN npm install
|
|
11
|
+
|
|
12
|
+
COPY . .
|
|
13
|
+
|
|
14
|
+
# Fix for Astro in Docker: https://github.com/withastro/astro/issues/2596
|
|
15
|
+
ENV NODE_OPTIONS=--max_old_space_size=2048
|
|
16
|
+
RUN npm run build
|
|
17
|
+
|
|
18
|
+
ENV HOST=0.0.0.0
|
|
19
|
+
ENV PORT=3000
|
|
20
|
+
EXPOSE 3000
|
|
21
|
+
|
|
22
|
+
# Start the server
|
|
23
|
+
CMD npm run start
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
|
|
2
|
+
# Get 14 day trial license key from https://eventcatalog.cloud/
|
|
3
|
+
EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=
|
|
4
|
+
|
|
5
|
+
# Confluent Schema Registry API Keys (you can get them from Confluent cloud)
|
|
6
|
+
CONFLUENT_SCHEMA_REGISTRY_KEY=
|
|
7
|
+
CONFLUENT_SCHEMA_REGISTRY_KEY_SECRET=
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
|
|
2
|
+
export default {
|
|
3
|
+
title: 'EventCatalog',
|
|
4
|
+
tagline: 'This internal platform provides a comprehensive view of our event-driven architecture across all systems. Use this portal to discover existing domains, explore services and their dependencies, and understand the message contracts that connect our infrastructure',
|
|
5
|
+
organizationName: '<organizationName>',
|
|
6
|
+
homepageLink: 'https://eventcatalog.dev/',
|
|
7
|
+
editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
|
|
8
|
+
// By default set to false, add true to get urls ending in /
|
|
9
|
+
trailingSlash: false,
|
|
10
|
+
// Change to make the base url of the site different, by default https://{website}.com/docs,
|
|
11
|
+
// changing to /company would be https://{website}.com/company/docs,
|
|
12
|
+
base: '/',
|
|
13
|
+
// Customize the logo, add your logo to public/ folder
|
|
14
|
+
logo: {
|
|
15
|
+
alt: 'EventCatalog Logo',
|
|
16
|
+
src: '/logo.png',
|
|
17
|
+
text: 'EventCatalog'
|
|
18
|
+
},
|
|
19
|
+
// Enable RSS feed for your eventcatalog
|
|
20
|
+
rss: {
|
|
21
|
+
enabled: true,
|
|
22
|
+
// number of items to include in the feed per resource (event, service, etc)
|
|
23
|
+
limit: 20
|
|
24
|
+
},
|
|
25
|
+
docs: {
|
|
26
|
+
sidebar: {
|
|
27
|
+
// TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
|
|
28
|
+
// LIST_VIEW will render the DOCS that look familiar to API documentation websites
|
|
29
|
+
type: 'LIST_VIEW'
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
// required random generated id used by eventcatalog
|
|
33
|
+
cId: '<cId>',
|
|
34
|
+
generators: [
|
|
35
|
+
[
|
|
36
|
+
'@eventcatalog/generator-confluent-schema-registry',
|
|
37
|
+
{
|
|
38
|
+
// The URL for your schema registry
|
|
39
|
+
schemaRegistryUrl: 'http://localhost:8081',
|
|
40
|
+
// This will document all the schemas in the registry, not just the latest version (default is false)
|
|
41
|
+
includeAllVersions: true
|
|
42
|
+
},
|
|
43
|
+
],
|
|
44
|
+
],
|
|
45
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
/* Custom styling support coming soon. */
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Dependencies
|
|
2
|
+
/node_modules
|
|
3
|
+
|
|
4
|
+
# Production
|
|
5
|
+
/build
|
|
6
|
+
|
|
7
|
+
# Generated files
|
|
8
|
+
.astro
|
|
9
|
+
out
|
|
10
|
+
dist
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# Misc
|
|
14
|
+
.DS_Store
|
|
15
|
+
.env.local
|
|
16
|
+
.env.development.local
|
|
17
|
+
.env.test.local
|
|
18
|
+
.env.production.local
|
|
19
|
+
|
|
20
|
+
npm-debug.log*
|
|
21
|
+
yarn-debug.log*
|
|
22
|
+
yarn-error.log*
|
|
23
|
+
|
|
24
|
+
.eventcatalog-core
|
|
25
|
+
|
|
26
|
+
.env
|
|
27
|
+
.env-*
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
strict-peer-dependencies=false
|
|
Binary file
|
package/templates/index.ts
CHANGED
|
@@ -82,6 +82,10 @@ export const installTemplate = async ({
|
|
|
82
82
|
dependencies.push("@eventcatalog/generator-openapi");
|
|
83
83
|
}
|
|
84
84
|
|
|
85
|
+
if (template === "confluent") {
|
|
86
|
+
dependencies.push("@eventcatalog/generator-confluent-schema-registry");
|
|
87
|
+
}
|
|
88
|
+
|
|
85
89
|
// "@myuser/my-package": "file:../lib"
|
|
86
90
|
const devDependencies = [] as any;
|
|
87
91
|
|
package/templates/types.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { PackageManager } from "../helpers/get-pkg-manager";
|
|
2
2
|
|
|
3
|
-
export type TemplateType = "default" | "app" | "empty" | "asyncapi" | "openapi";
|
|
3
|
+
export type TemplateType = "default" | "app" | "empty" | "asyncapi" | "openapi" | "confluent";
|
|
4
4
|
export type TemplateMode = "js" | "ts";
|
|
5
5
|
|
|
6
6
|
export interface GetTemplateFileArgs {
|