Merge pull request #1 from ourchitecture/our-dev

docs: web architecture

.gitattributes

@@ -0,0 +1,20 @@
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+# Force the following filetypes to have unix line endings, so Windows does not break them
+*.sh eol=lf
+*.md eol=lf
+
+# Force the following filetypes to have windows line endings, so Windows does not break them
+*.bat eol=crlf
+*.cmd eol=crlf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.gif binary
+*.ico binary
+*.min.js binary
+
+# The above will handle all JS and JSON files in the repository if detected as text files

.github/workflows/repository_ci.yaml

@@ -43,6 +43,6 @@ jobs:
               name: Setup Wireit cache
               uses: google/wireit@setup-github-actions-caching/v1
 
-            - id: check-repository
-              name: Check repository
-              run: make check-repository
+            - id: make
+              name: make
+              run: make

.markdownlint-cli2.yaml

@@ -6,6 +6,7 @@ ignores:
     - '**/.vscode/**'
     - '**/.wireit/**'
     - '**/node_modules/**'
+    - 'src/systems/dev/backstage/**'
 config:
     # Spaces after list markers.
     MD030:

.prettierignore

@@ -18,3 +18,5 @@
 **/.yarnrc.yaml
 **/LICENSE
 **/yarn.lock
+
+src/systems/dev/backstage/

makefile

@@ -1,14 +1,138 @@
 .DEFAULT_GOAL:=all
 
-all: check
+all: init install check
 
-.PHONY: install
-install:
+.PHONY: init
+init:
+	@echo "Initializing monorepo..."
 	@yarn install --immutable
+	@yarn workspaces foreach --all --interlaced run install --immutable
+	@echo "Successfully initialized monorepo."
+
+	@echo "Initializing independent projects..."
+	@cd ./src/systems/dev/backstage/ourstage && make $@
+	@echo "Successfully initialized independent projects."
 
-.PHONY: check-repository
-check-repository: install
-	@yarn lint
+.PHONY: install
+install:
+	@echo "Installing independent projects..."
+	@cd ./src/systems/dev/backstage/ourstage && make $@
+	@echo "Successfully installed independent projects."
 
 .PHONY: check
-check: check-repository
+check:
+	@echo "Checking monorepo..."
+	@yarn workspaces foreach --all --interlaced run lint
+	@echo "Successfully checked monorepo."
+
+	@echo "Checking independent projects..."
+	@cd ./src/systems/dev/backstage/ourstage && make $@
+	@echo "Successfully checked independent projects."
+
+################################################################################
+# Git convience commands
+################################################################################
+
+.PHONY: hack
+hack:
+ifndef name
+	$(error name is not set)
+endif
+	@git-town hack $(name)
+
+.PHONY: sync
+sync:
+	@git-town sync
+
+.PHONY: chore
+chore:
+ifndef m
+	$(error message "m" is not set)
+endif
+	@git add .
+ifdef f
+	@git commit -asm "chore($(f)): $(m)"
+else
+	@git commit -asm "chore: $(m)"
+endif
+
+.PHONY: fix
+fix:
+ifndef m
+	$(error message "m" is not set)
+endif
+	@git add .
+ifdef f
+	@git commit -asm "fix($(f)): $(m)"
+else
+	@git commit -asm "fix: $(m)"
+endif
+
+.PHONY: bug
+bug: fix
+
+.PHONY: docs
+docs:
+ifndef m
+	$(error message "m" is not set)
+endif
+	@git add .
+ifdef f
+	@git commit -asm "docs($(f)): $(m)"
+else
+	@git commit -asm "docs: $(m)"
+endif
+
+.PHONY: ci
+ci:
+ifndef m
+	$(error message "m" is not set)
+endif
+	@git add .
+ifdef f
+	@git commit -asm "ci($(f)): $(m)"
+else
+	@git commit -asm "ci: $(m)"
+endif
+
+.PHONY: feat
+feat:
+ifndef m
+	$(error message "m" is not set)
+endif
+	@git add .
+ifdef f
+	@git commit -asm "feat($(f)): $(m)"
+else
+	@git commit -asm "feat: $(m)"
+endif
+
+.PHONY: pr
+pr:
+	@gh pr create \
+		--repo ourchitecture/monorepo \
+		--base main \
+		--fill-first \
+		--assignee @
+.PHONY: pr-chore
+pr-chore: pr
+
+.PHONY: pr-feat
+pr-feat:
+	@gh pr create \
+		--repo ourchitecture/monorepo \
+		--base main \
+		--fill-first \
+		--assignee @me \
+		--label enhancement
+
+.PHONY: pr-fix
+pr-fix:
+	@gh pr create \
+		--repo ourchitecture/monorepo \
+		--base main \
+		--fill-first \
+		--assignee @me \
+		--label bug
+.PHONY: pr-bug
+pr-bug: pr-fix

package.json

@@ -27,21 +27,34 @@
     "packageManager": "yarn@4.1.0",
     "private": true,
     "repository": "https://github.com/ourchitecture/monorepo/",
+    "resolutions": {
+        "@types/react": "^18",
+        "@types/react-dom": "^18"
+    },
     "scripts": {
+        "build:ourstage": "wireit",
         "format": "prettier --write .",
         "lint:md": "wireit",
+        "lint:ourstage": "wireit",
         "lint:prettier": "wireit",
         "lint": "wireit",
+        "test:ourstage": "wireit",
         "prepare": "husky"
     },
     "version": "1.0.0-alpha.0",
     "wireit": {
+        "build:ourstage": {
+            "command": "cd ./src/systems/dev/backstage/ourstage && yarn build"
+        },
         "lint:md": {
             "command": "markdownlint-cli2",
             "files": [
                 "src/**/*.md"
             ]
         },
+        "lint:ourstage": {
+            "command": "cd ./src/systems/dev/backstage/ourstage && yarn lint"
+        },
         "lint:prettier": {
             "command": "prettier --check ."
         },
@@ -50,11 +63,13 @@
                 "lint:md",
                 "lint:prettier"
             ]
+        },
+        "test:ourstage": {
+            "command": "cd ./src/systems/dev/backstage/ourstage && yarn test"
         }
     },
-    "workspaces": {
-        "packages": [
-            "src/**/*"
-        ]
-    }
+    "workspaces": [
+        "src/designs/**/*",
+        "src/systems/leadof/**/*"
+    ]
 }

src/designs/website-architecture/website-architecture.drawio

@@ -0,0 +1,49 @@
+<mxfile host="65bd71144e">
+    <diagram id="c_1d0xFm4zSnHDSdEgfX" name="Page-1">
+        <mxGraphModel dx="1487" dy="771" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="5" style="edgeStyle=none;html=1;fontSize=16;strokeWidth=3;dashed=1;endArrow=block;endFill=1;startArrow=block;startFill=1;shadow=0;" edge="1" parent="1" source="3" target="2">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="7" style="edgeStyle=none;sketch=0;html=1;shadow=0;dashed=1;strokeWidth=3;fontSize=16;startArrow=block;startFill=1;endArrow=block;endFill=1;" edge="1" parent="1" source="3" target="6">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="3" value="Website Server-Side Rendering (SSR)" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;" vertex="1" parent="1">
+                    <mxGeometry x="130" y="400" width="190" height="110" as="geometry"/>
+                </mxCell>
+                <mxCell id="2" value="Front-end&lt;br style=&quot;font-size: 16px;&quot;&gt;Website" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;" vertex="1" parent="1">
+                    <mxGeometry x="130" y="160" width="190" height="110" as="geometry"/>
+                </mxCell>
+                <mxCell id="6" value="Back-end For Front-end&amp;nbsp; (BFF) API" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;" vertex="1" parent="1">
+                    <mxGeometry x="130" y="640" width="190" height="110" as="geometry"/>
+                </mxCell>
+                <mxCell id="16" value="" style="edgeStyle=none;sketch=0;html=1;shadow=0;dashed=1;strokeWidth=3;fontSize=16;startArrow=block;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="9" target="2">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="18" style="edgeStyle=none;sketch=0;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;shadow=0;dashed=1;strokeWidth=3;fontSize=16;startArrow=block;startFill=1;endArrow=block;endFill=1;" edge="1" parent="1" source="9" target="6">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="9" value="" style="strokeWidth=1;shadow=0;dashed=0;align=center;html=1;shape=mxgraph.mockup.containers.browserWindow;rSize=0;strokeColor=#666666;strokeColor2=#008cff;strokeColor3=#c4c4c4;mainText=,;recursiveResize=0;fontSize=16;" vertex="1" parent="1">
+                    <mxGeometry x="440" y="302.5" width="380" height="305" as="geometry"/>
+                </mxCell>
+                <mxCell id="10" value="Ourchitecture" style="strokeWidth=1;shadow=0;dashed=0;align=center;html=1;shape=mxgraph.mockup.containers.anchor;fontSize=17;fontColor=#666666;align=left;" vertex="1" parent="9">
+                    <mxGeometry x="60" y="12" width="110" height="26" as="geometry"/>
+                </mxCell>
+                <mxCell id="11" value="https://www.ourchitecture.io" style="strokeWidth=1;shadow=0;dashed=0;align=center;html=1;shape=mxgraph.mockup.containers.anchor;rSize=0;fontSize=17;fontColor=#666666;align=left;" vertex="1" parent="9">
+                    <mxGeometry x="130" y="60" width="250" height="26" as="geometry"/>
+                </mxCell>
+                <mxCell id="8" value="Browser offline data storage" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fontSize=16;" vertex="1" parent="9">
+                    <mxGeometry x="60" y="140" width="120" height="140" as="geometry"/>
+                </mxCell>
+                <mxCell id="17" style="edgeStyle=none;sketch=0;html=1;shadow=0;dashed=1;strokeWidth=3;fontSize=16;startArrow=block;startFill=1;endArrow=block;endFill=1;" edge="1" parent="1" source="15" target="9">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="15" value="Consumer" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;fontSize=16;" vertex="1" parent="1">
+                    <mxGeometry x="930" y="395" width="60" height="120" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>

src/systems/dev/backstage/ourstage/.dockerignore

@@ -0,0 +1,8 @@
+.git
+.yarn/cache
+.yarn/install-state.gz
+node_modules
+packages/*/src
+packages/*/node_modules
+plugins
+*.local.yaml

src/systems/dev/backstage/ourstage/.eslintignore

@@ -0,0 +1 @@
+playwright.config.ts

src/systems/dev/backstage/ourstage/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  root: true,
+};

src/systems/dev/backstage/ourstage/.gitignore

@@ -0,0 +1,54 @@
+# macOS
+.DS_Store
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Coverage directory generated when running tests with coverage
+coverage
+
+# Dependencies
+node_modules/
+
+# Yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Node version directives
+.nvmrc
+
+# dotenv environment variables file
+.env
+.env.test
+
+# Build output
+dist
+dist-types
+
+# Temporary change files created by Vim
+*.swp
+
+# MkDocs build output
+site
+
+# Local configuration files
+*.local.yaml
+
+# Sensitive credentials
+*-credentials.yaml
+
+# vscode database functionality support files
+*.session.sql
+
+# E2E test reports
+e2e-test-report/

src/systems/dev/backstage/ourstage/.prettierignore

@@ -0,0 +1,4 @@
+dist
+dist-types
+coverage
+.vscode