Skip to content

Commit fc37097

Browse files
committed
ATR-18 Structurizr for Arc42 stuff only + enabled diagram embedding
1 parent 5c4fdd6 commit fc37097

File tree

8 files changed

+50
-19
lines changed

8 files changed

+50
-19
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
/site
22
**/.DS_Store
3-
/workspace.json
4-
/.structurizr
5-
/.vscode/settings.json
3+
/.vscode/settings.json
4+
.idea

compose.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ services:
44
container_name: ng2r-structurizr-lite
55
restart: always
66
volumes:
7-
- ./docs:/usr/local/structurizr
7+
- ./structurizr:/usr/local/structurizr/ng2react
8+
- ./docs/images:/usr/local/structurizr/ng2react/arc42/images:ro
9+
- ./docs/diagrams:/usr/local/structurizr/ng2react/arc42/diagrams:ro
10+
environment:
11+
- STRUCTURIZR_WORKSPACE_PATH=ng2react
812
ports:
913
- 9000:8080

docs/.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
/workspace.json
2-
/.structurizr
31
/.vscode/settings.json

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ site_name: AngularJS to React
22
site_url: https://marketplace.visualstudio.com/items?itemName=maxbilbow.ng2react-vscode&ssr=false#overview
33
nav:
44
- Home: index.md
5-
- Arc24: arc42.md
65
- Extensions: VSCode.md
76
- "@ng2react/support": ng2react-support.md
87
- About: about.md

structurizr/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
workspace.json
2+
.structurizr

docs/arc42.md renamed to structurizr/arc42/arc42.md

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
**NG2React**
22

3-
# Introduction and Goals
4-
5-
Describes the relevant requirements and the driving forces that software
6-
architects and development team must consider. These include
7-
8-
- underlying business goals, essential features and functional
9-
requirements for the system
3+
![](images/icon.png)
104

11-
- quality goals for the architecture
5+
# Introduction and Goals
126

13-
- relevant stakeholders and their expectations
7+
The overarching aim is to leverage the capabilities of GPT-4 to significantly reduce the time and effort needed to migrate an AngularJS codebase to React.
148

159
## Requirements Overview
1610

@@ -247,7 +241,7 @@ level without disclosing implementation details.
247241
The building block view is a hierarchical collection of black boxes and
248242
white boxes (see figure below) and their descriptions.
249243

250-
![Hierarchy of building blocks](images/05_building_blocks-EN.png)
244+
![Hierarchy of building blocks](../images/05_building_blocks-EN.png)
251245

252246
**Level 1** is the white box description of the overall system together
253247
with black box descriptions of all contained building blocks.
@@ -290,6 +284,39 @@ following white box template. It contains
290284

291285
**_<Overview Diagram>_**
292286

287+
<iframe id="SystemContext" src="/workspace/embed?diagram=SystemContext&diagramSelector=false&iframe=SystemContext" width="50%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>
288+
<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>
289+
290+
[//]: # ()
291+
[//]: # (<iframe id="IDE_Containers" src="/workspace/embed?diagram=IDE_Containers&diagramSelector=false&iframe=IDE_Containers" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
292+
293+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
294+
295+
[//]: # ()
296+
[//]: # (<iframe id="IDE_Containers_VSCode" src="/workspace/embed?diagram=IDE_Containers_VSCode&diagramSelector=false&iframe=IDE_Containers_VSCode" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
297+
298+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
299+
300+
[//]: # ()
301+
[//]: # (<iframe id="IDE_Containers_Generic" src="/workspace/embed?diagram=IDE_Containers_Generic&diagramSelector=false&iframe=IDE_Containers_Generic" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
302+
303+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
304+
305+
[//]: # ()
306+
[//]: # (<iframe id="Generic_IDE_Plugins" src="/workspace/embed?diagram=Generic_IDE_Plugins&diagramSelector=false&iframe=Generic_IDE_Plugins" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
307+
308+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
309+
310+
[//]: # ()
311+
[//]: # (<iframe id="NodeJS_IDE_Plugins" src="/workspace/embed?diagram=NodeJS_IDE_Plugins&diagramSelector=false&iframe=NodeJS_IDE_Plugins" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
312+
313+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
314+
315+
[//]: # ()
316+
[//]: # (<iframe id="Ng2React_Core" src="/workspace/embed?diagram=Ng2React_Core&diagramSelector=false&iframe=Ng2React_Core" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>)
317+
318+
[//]: # (<script type="text/javascript" src="https://static.structurizr.com/js/structurizr-embed.js"></script>)
319+
293320
Motivation
294321

295322
: _&lt;text explanation&gt;_
@@ -635,7 +662,7 @@ A potential (but not mandatory) structure for this section could be:
635662
Note: it might be difficult to assign individual concepts to one
636663
specific topic on this list.
637664

638-
![Possible topics for crosscutting concepts](images/08-Crosscutting-Concepts-Structure-EN.png)
665+
![Possible topics for crosscutting concepts](../images/08-Crosscutting-Concepts-Structure-EN.png)
639666

640667
## _&lt;Concept 1&gt;_
641668

@@ -810,3 +837,5 @@ Potentially more columns in case you need translations.
810837
| ------ | -------------------- |
811838
| Term 1 | &lt;definition-1&gt; |
812839
| Term 2 | &lt;definition-2&gt; |
840+
841+
File renamed without changes.

docs/workspace.dsl renamed to structurizr/workspace.dsl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
workspace "ng2react" "A tool that converts AngularJS components to React using OpenAI API" {
2-
!docs .
2+
!docs ./arc42
33
model {
44
openAiApi = softwareSystem "OpenAI" "Public API for generative AI" "External"
55

0 commit comments

Comments
 (0)