check

Author: RDBModel

README.md

@@ -1,18 +1,27 @@
-# Welcome to the RDB Model!
+# RDB Model
 
-This web application allows you to create and visualize software architecture using a simplified version of the C4 model. You can create and edit yaml files that represent the domain of your application. It's important to note that while there is only one domain that represents the architecture, but it is possible to create multiple views of this domain to better understand and communicate the relationships within a software system(s).
+This web application simplifies creating and visualizing software architecture using a C4 model variant. You can edit YAML files to represent your application's domain. You can create multiple views to understand and communicate relationships within the software system.
 
-Views allow to see the connections between actors, systems, containers, and their components. It is possible to layout the elements and edges of a view, that allowing to arrange and present the software architecture in a clear and visually appealing way. Other features like zoom, scroll, and navigate through the selected view, are allowing to easily explore and understand the software architecture in greater detail.
+## Functionality Highlights
 
-This app also helps you during the editing process by highlighting any inconsistencies in the model and views using error messages. This ensures that the software architecture is clear and consistent.
+- Create and edit YAML files representing the software architecture domain.
+- Generate multiple views to visualize connections between actors, systems, containers, and components.
+- Layout elements and edges for clear, visually appealing architecture representations.
+- Features like zoom, scroll, and navigation enhance exploration of the software architecture.
+- Error highlighting ensures consistency and clarity during the editing process.
 
-The C4 model is a powerful tool for understanding and communicating the structure of a software system, and is typically used to represent the domain of the application. There are the four main types of entities in the C4 model: actors, systems, containers, and components. Systems in the C4 model usually represent applications or services that bring value to the end users, while containers are units that can usually be deployed independently. Components, on the other hand, are buildable packages that are usually represented as artifacts in the file system.
+## C4 Model Overview
 
-Whether you're a seasoned software architect or just starting out, our application makes it easy to design and understand your software architecture. Start creating your C4 model with the RDB Model Web Application today!
+The C4 model represents software systems through four main entities: actors, systems, containers, and components.
 
-# Getting started
+- **Actors:** Represent users or external systems interacting with the software.
+- **Systems:** Represent applications or services providing value to users.
+- **Containers:** Deployable units that can operate independently.
+- **Components:** Buildable packages, like artifacts in a file system.
 
-1. Start with minimal domain in the editor:
+## Getting Started
+
+1. Start with a minimal domain in the editor:
 
 ```yaml
 domain:
@@ -33,16 +42,9 @@ domain:
               name: component 1
 ```
 
-2. Add all actors and systems. Usually there is only one target system that is managed by your company/team. All others system acts as external systems (so you have no information about their contains/components) and the target system is using or used by such external systems.
-
-3. Add all relations between actors, external systems and the target system. Actors use the target system and they are clients. One type of external systems can use the target system and other type of external systems can be used by the target system.
-
-4. Add all containers of the target system (units that are deployed or can be deployed independently).
-
-5. Add all relations between containers, e.g. web service is using database.
-
-6. Add all components of created containers (buildable packages, dlls, database schemas, jars).
-
-7. Add all relations between components
+2. Add actors, systems, and relations.
+3. Define containers and their relations.
+4. Add components to containers and specify relations.
+5. Create views to visualize the architecture.
 
-8. Start creating views after domain. It is possible to create views vie editor and also via graphical interface.
+Start designing your C4 model with the RDB Model Web Application today!

src/Pages/Home.elm

@@ -28,7 +28,7 @@ import Element
         )
 import Element.Background as Background
 import Element.Border exposing (rounded)
-import Element.Font as Font exposing (justify)
+import Element.Font as Font
 import Html exposing (Html)
 import Route exposing (editorLinkDropbox, editorLinkInit, editorLinkPastebin, editorLinkTwitter)
 
@@ -118,3 +118,33 @@ mainPartShort =
         , editorLink
         , footer
         ]
+
+-- Create any new view for the domain
+-- Edit any existing view
+-- Select any view from existing views using dropdown or using direct link
+-- Describe domain in the text editor using hints
+    -- Add name and desription for the domain
+    -- Add actors (name, description)
+    -- Add systems (external and target one) by providing names and descriptions
+    -- Add containers to the interested system (name and description)
+    -- Add components to the interested containers (name and description)
+    -- Add blocks to the interested components (name and description)
+    -- Add relations to all interested actors, systems, containers, components and blocks (short description and the target item)
+-- Create a view for the created domain (plus button)
+    -- Add any type of items to the view
+    -- Move and adjust item position on the view by dragging the item box
+    -- Binding to grid can be enabled so items will be aligned to the grid
+    -- Right click on an added item to add relations from it to any other item on the view which is described in the domain
+    -- Right click on an added item to remove it from the view
+    -- Click on an arrow (relation) to modify its appearance on the view
+    -- Right click on the arrow (relation) to remove it from the view
+    -- Add any child item of the existing item and it will be placed inside the parent item (e.g. all containers will be inside its parent system)
+    -- Select multiple items on the view and move them on the view simultaneously
+    -- Hold Ctrl and click on the view to move up, down, left or right
+    -- Use button 'Move' to start navigating on view instead of item selecting
+    -- Use zoom buttons to zoom in and zoom out
+    -- Any action on view can be undone and redone (history)
+-- Any inconsistency in domain and its views will be highlighted in the document
+-- Many view can be added to represent different slices of the domain
+-- Save the yaml to the local storage of the browser
+-- Download/upload yaml