From a55f3fb1fed7866ed45fc8b6f4370d98998ac566 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 13:32:27 +0100 Subject: [PATCH 01/14] Setup guide --- config/secrets.env.example | 4 ++-- docs/setup.md | 40 ++++++++++++++++++-------------------- 2 files changed, 21 insertions(+), 23 deletions(-) diff --git a/config/secrets.env.example b/config/secrets.env.example index 524b28637..067760b23 100644 --- a/config/secrets.env.example +++ b/config/secrets.env.example @@ -1,4 +1,4 @@ # Secret keys # DO NOT COMMIT -OPENAI_KEY= -GROQ_API_KEY= \ No newline at end of file +OPENAI_KEY="" +GROQ_API_KEY="" \ No newline at end of file diff --git a/docs/setup.md b/docs/setup.md index 0b6b1d9bf..5be59a476 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -10,37 +10,35 @@ AI4MDE · Installation Guide -Get up and running with the AI4MDE studio and API in no time: +> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher (instalaltion guide [here](https://learn.microsoft.com/en-us/windows/wsl/install)), +> and set up Docker Desktop accordingly (instructions [here](https://docs.docker.com/desktop/features/wsl/)). -``` -git clone https://github.com/ai4mde/studio.git -cd frontend -docker-compose up -d -``` +> ☝️ If you are working on a Linux distribution, you may use a regular terminal. +> Make sure you have installed Docker Engine (guides [here](https://docs.docker.com/engine/install/)) +> or Docker Desktop (guides [here](https://docs.docker.com/desktop/setup/install/linux/)). -Now visit [http://ai4mde.localhost](http://ai4mde.localhost) +> ☝️ If you are working on macOS, you may should be able to use a regular terminal. +> Make sure you have installed or Docker Desktop (guides [here](https://docs.docker.com/desktop/setup/install/mac-install/)). -
+> ☝️ If you are using Docker Desktop, make sure this is running on your device before using the commands below in your terminal. -## Installation +With your environment correctly set up, you can get started from a Linux, macOS or WSL terminal: -> ☝️ This project is assumes you run a GNU/Linux system. -> If you find yourself on Windows, please work from WSL2. -> You should be fine on macOS. If you're just running without -> contributing, ignore the above. +```bash +# Ensure that you have the Docker installed +docker -v +docker compose version -The easiest way to get started is through a container runtime and the docker compose file at the root. If these terms are unfamiliar to you, start with installing a container runtime. +# Clone the repository +git clone https://github.com/ai4mde/studio.git -Before the environment can be built, secret API keys need to be specified in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. +# Go to the root directory +cd studio +``` -With everything ready and this repository cloned, you can get started from a shell: +Before the environment can be built, you need to provide your secret OpenAI and Groq API keys in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. You have to perform this step in order run the software, however you may leave the values empty if you are not interested in using the LLM features. Feel free to use the terminal or any code/text editor for this step. ```bash -# Ensure that you have the correct tools installed, you might have to restart -# your shell -docker -v -docker compose version - # Build all the necessary images (only required on first install or dependency change) docker compose build From 467c410e42aff2dba286015e8310e7279f3aff05 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 13:34:51 +0100 Subject: [PATCH 02/14] Setup guide links --- docs/setup.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 5be59a476..53f1f8b01 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -10,15 +10,14 @@ AI4MDE · Installation Guide -> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher (instalaltion guide [here](https://learn.microsoft.com/en-us/windows/wsl/install)), -> and set up Docker Desktop accordingly (instructions [here](https://docs.docker.com/desktop/features/wsl/)). +> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher ([instalaltion guide](https://learn.microsoft.com/en-us/windows/wsl/install)), +> and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). -> ☝️ If you are working on a Linux distribution, you may use a regular terminal. -> Make sure you have installed Docker Engine (guides [here](https://docs.docker.com/engine/install/)) -> or Docker Desktop (guides [here](https://docs.docker.com/desktop/setup/install/linux/)). +> ☝️ If you are working on a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine +> ([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). -> ☝️ If you are working on macOS, you may should be able to use a regular terminal. -> Make sure you have installed or Docker Desktop (guides [here](https://docs.docker.com/desktop/setup/install/mac-install/)). +> ☝️ If you are working on macOS, you may should be able to use a regular terminal. Make sure you have installed or Docker Desktop +> ([guides](https://docs.docker.com/desktop/setup/install/mac-install/)). > ☝️ If you are using Docker Desktop, make sure this is running on your device before using the commands below in your terminal. From b119c5370a422e6118eb5d5394eb60ea0a1b2253 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:04:17 +0100 Subject: [PATCH 03/14] Credentials and secrets --- docs/setup.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 53f1f8b01..3750d9b71 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -10,16 +10,18 @@ AI4MDE · Installation Guide -> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher ([instalaltion guide](https://learn.microsoft.com/en-us/windows/wsl/install)), +> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), > and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). > ☝️ If you are working on a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine > ([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). -> ☝️ If you are working on macOS, you may should be able to use a regular terminal. Make sure you have installed or Docker Desktop -> ([guides](https://docs.docker.com/desktop/setup/install/mac-install/)). +> ☝️ If you are working on macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop +> ([installation guide](https://docs.docker.com/desktop/setup/install/mac-install/)). -> ☝️ If you are using Docker Desktop, make sure this is running on your device before using the commands below in your terminal. +> Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). + +> If you are using Docker Desktop, make sure this is running on your device before using the commands below in your terminal. With your environment correctly set up, you can get started from a Linux, macOS or WSL terminal: @@ -30,19 +32,25 @@ docker compose version # Clone the repository git clone https://github.com/ai4mde/studio.git - -# Go to the root directory cd studio ``` -Before the environment can be built, you need to provide your secret OpenAI and Groq API keys in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. You have to perform this step in order run the software, however you may leave the values empty if you are not interested in using the LLM features. Feel free to use the terminal or any code/text editor for this step. +Before the environment can be built, you need to provide your secret OpenAI and Groq API keys in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. You have to perform this step in order to run the software, however you may leave the values empty if you are not interested in using the LLM features. Feel free to use the terminal or any code/text editor for this step. + +Also, take note of the username and password stored in files `config/api.env` and `config/prototypes.env`. These are your credentials for logging into AI4MDE, and any potential web application prototypes you might generate with it, respectively: DJANGO_SUPERUSER_USERNAME=admin and DJANGO_SUPERUSER_PASSWORD=sequoias. You may update your credentials in these files if you wish. ```bash -# Build all the necessary images (only required on first install or dependency change) -docker compose build +# Configure secrets (required file; values optional if you won't use LLM features) +cp config/secrets.env.example config/secrets.env +# edit config/secrets.env +# edit config/api.env +# edit config/prototypes.env + +# Build and Start all the containers (add -d flag to start in background) +docker compose up -d -- build -# Start all the containers (add -d flag to start in background) -docker compose up +# To stop the containers, you can use +docker compose down ``` This will start multiple services in the background and set everything up (for development). As soon as that's done, you can find the following services on your machine's network: From 3924060903a9ad057dac090a0e0c7316f6880a12 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:19:17 +0100 Subject: [PATCH 04/14] Requirements specification --- docs/setup.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 3750d9b71..37ae0fc2f 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -10,20 +10,19 @@ AI4MDE · Installation Guide -> ☝️ If you are working on Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), -> and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). - -> ☝️ If you are working on a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine -> ([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). - -> ☝️ If you are working on macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop +> ☝️ Depending on your operating system, you should set up your envirnoment to meet the following requirements: +> - For Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), +> and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). +> - For a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine +> ([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). +> - For macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop > ([installation guide](https://docs.docker.com/desktop/setup/install/mac-install/)). -> Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). +> ☝️ Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). -> If you are using Docker Desktop, make sure this is running on your device before using the commands below in your terminal. +> ☝️ If you are using Docker Desktop, make sure it is running on your device before using the commands below in your terminal. -With your environment correctly set up, you can get started from a Linux, macOS or WSL terminal: +With these requirements met, you can get started from a Linux, macOS or WSL terminal: ```bash # Ensure that you have the Docker installed @@ -37,7 +36,7 @@ cd studio Before the environment can be built, you need to provide your secret OpenAI and Groq API keys in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. You have to perform this step in order to run the software, however you may leave the values empty if you are not interested in using the LLM features. Feel free to use the terminal or any code/text editor for this step. -Also, take note of the username and password stored in files `config/api.env` and `config/prototypes.env`. These are your credentials for logging into AI4MDE, and any potential web application prototypes you might generate with it, respectively: DJANGO_SUPERUSER_USERNAME=admin and DJANGO_SUPERUSER_PASSWORD=sequoias. You may update your credentials in these files if you wish. +Also, take note of the username and password stored in files `config/api.env` and `config/prototypes.env`. These are your credentials for logging into AI4MDE, and any potential web application prototypes you might generate with it, respectively: `DJANGO_SUPERUSER_USERNAME = admin` and `DJANGO_SUPERUSER_PASSWORD = sequoias`. You may update your credentials in these files if you wish. ```bash # Configure secrets (required file; values optional if you won't use LLM features) @@ -47,7 +46,7 @@ cp config/secrets.env.example config/secrets.env # edit config/prototypes.env # Build and Start all the containers (add -d flag to start in background) -docker compose up -d -- build +docker compose up -d --build # To stop the containers, you can use docker compose down @@ -55,7 +54,7 @@ docker compose down This will start multiple services in the background and set everything up (for development). As soon as that's done, you can find the following services on your machine's network: -- [ai4mde.localhost](http://ai4mde.localhost) - Frontend, from `/frontend` +- [ai4mde.localhost](http://ai4mde.localhost) - Frontend, from `/frontend`. As a non-contributing user, this is where you can interact with the AI4MDE tool. - [api.ai4mde.localhost](http://api.ai4mde.localhost) - API from `/api` - [prototype.ai4mde.localhost](http://prototype.ai4mde.localhost) - Running prototype in `/prototypes/generated_prototypes` - [prototypes_api.ai4mde.localhost](http://prototypes_api.ai4mde.localhost) - Prototype management API from `/prototypes/backend` From 8557edd340daaf02fa03ee8308c37485b395c061 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:20:33 +0100 Subject: [PATCH 05/14] Layout change --- docs/setup.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 37ae0fc2f..0696a742d 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -10,15 +10,15 @@ AI4MDE · Installation Guide -> ☝️ Depending on your operating system, you should set up your envirnoment to meet the following requirements: -> - For Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), -> and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). -> - For a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine -> ([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). -> - For macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop -> ([installation guide](https://docs.docker.com/desktop/setup/install/mac-install/)). - -> ☝️ Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). +Depending on your operating system, you should set up your envirnoment to meet the following requirements: +- For Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), +and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). +- For a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine +([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). +- For macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop +([installation guide](https://docs.docker.com/desktop/setup/install/mac-install/)). + +Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). > ☝️ If you are using Docker Desktop, make sure it is running on your device before using the commands below in your terminal. From 557072329dbf4018831461c3db77cb5658e2c9be Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:25:05 +0100 Subject: [PATCH 06/14] Hyperlinks --- docs/setup.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 0696a742d..a640d1782 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -11,14 +11,12 @@ Depending on your operating system, you should set up your envirnoment to meet the following requirements: -- For Windows, please work from WSL 2.1.5 or higher ([installation guide](https://learn.microsoft.com/en-us/windows/wsl/install)), -and set up Docker Desktop accordingly ([instructions](https://docs.docker.com/desktop/features/wsl/)). -- For a Linux distribution, you may use a regular terminal. Make sure you have installed Docker Engine -([guides](https://docs.docker.com/engine/install/)) or Docker Desktop ([guides](https://docs.docker.com/desktop/setup/install/linux/)). -- For macOS, you should be able to use a regular terminal. Make sure you have installed or Docker Desktop -([installation guide](https://docs.docker.com/desktop/setup/install/mac-install/)). - -Make sure Git is installed on your device ([instructions](https://github.com/git-guides/install-git)). +- For Windows, please work from [WSL 2.1.5](https://learn.microsoft.com/en-us/windows/wsl/install) or higher, +and set up Docker Desktop according to these [instructions](https://docs.docker.com/desktop/features/wsl/). +- For a Linux distribution, you may use a regular terminal. Make sure you have installed [Docker Engine](https://docs.docker.com/engine/install/) or [Docker Desktop](https://docs.docker.com/desktop/setup/install/linux/). +- For macOS, you should be able to use a regular terminal. Make sure you have installed or [Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/). + +Make sure [Git](https://github.com/git-guides/install-git) is installed on your device. > ☝️ If you are using Docker Desktop, make sure it is running on your device before using the commands below in your terminal. From fe7654ef4524685b752bf9dda0b17362c3c845fd Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:28:33 +0100 Subject: [PATCH 07/14] Wording --- docs/setup.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index a640d1782..7ee4c4839 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -13,10 +13,10 @@ Depending on your operating system, you should set up your envirnoment to meet the following requirements: - For Windows, please work from [WSL 2.1.5](https://learn.microsoft.com/en-us/windows/wsl/install) or higher, and set up Docker Desktop according to these [instructions](https://docs.docker.com/desktop/features/wsl/). -- For a Linux distribution, you may use a regular terminal. Make sure you have installed [Docker Engine](https://docs.docker.com/engine/install/) or [Docker Desktop](https://docs.docker.com/desktop/setup/install/linux/). -- For macOS, you should be able to use a regular terminal. Make sure you have installed or [Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/). +- For a Linux distribution, you may use a regular terminal. Set up [Docker Engine](https://docs.docker.com/engine/install/) or [Docker Desktop](https://docs.docker.com/desktop/setup/install/linux/), as well. +- For macOS, you should also be able to use a regular terminal. Make sure to install [Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/). -Make sure [Git](https://github.com/git-guides/install-git) is installed on your device. +Check that [Git](https://github.com/git-guides/install-git) is installed on your device. > ☝️ If you are using Docker Desktop, make sure it is running on your device before using the commands below in your terminal. @@ -34,7 +34,7 @@ cd studio Before the environment can be built, you need to provide your secret OpenAI and Groq API keys in `/config/secrets.env`. An example of such a file can be seen in `/config/secrets.env.example`. You have to perform this step in order to run the software, however you may leave the values empty if you are not interested in using the LLM features. Feel free to use the terminal or any code/text editor for this step. -Also, take note of the username and password stored in files `config/api.env` and `config/prototypes.env`. These are your credentials for logging into AI4MDE, and any potential web application prototypes you might generate with it, respectively: `DJANGO_SUPERUSER_USERNAME = admin` and `DJANGO_SUPERUSER_PASSWORD = sequoias`. You may update your credentials in these files if you wish. +> ☝️ Also, take note of the username and password stored in files `config/api.env` and `config/prototypes.env`. These are your credentials for logging into AI4MDE, and any potential web application prototypes you might generate with it, respectively: `DJANGO_SUPERUSER_USERNAME = admin` and `DJANGO_SUPERUSER_PASSWORD = sequoias`. You may update your credentials in these files if you wish. ```bash # Configure secrets (required file; values optional if you won't use LLM features) @@ -52,7 +52,7 @@ docker compose down This will start multiple services in the background and set everything up (for development). As soon as that's done, you can find the following services on your machine's network: -- [ai4mde.localhost](http://ai4mde.localhost) - Frontend, from `/frontend`. As a non-contributing user, this is where you can interact with the AI4MDE tool. +- [ai4mde.localhost](http://ai4mde.localhost) - Frontend, from `/frontend`. As a non-contributing user, this is where you can interact with the AI4MDE tool. Use the credentials from `config/api.env` to log in. - [api.ai4mde.localhost](http://api.ai4mde.localhost) - API from `/api` - [prototype.ai4mde.localhost](http://prototype.ai4mde.localhost) - Running prototype in `/prototypes/generated_prototypes` - [prototypes_api.ai4mde.localhost](http://prototypes_api.ai4mde.localhost) - Prototype management API from `/prototypes/backend` From 06d477b71cbf2a8b2444deac10267827572540f7 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 15:46:00 +0100 Subject: [PATCH 08/14] diagram guide --- docs/users-guide.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/users-guide.md diff --git a/docs/users-guide.md b/docs/users-guide.md new file mode 100644 index 000000000..2cf1c919f --- /dev/null +++ b/docs/users-guide.md @@ -0,0 +1,19 @@ +p align="center"> + AI4MDE studio +

+ +

+ AI4MDE · Creating Diagrams +

+ +You can create diagrams from scratch in the `Projects` section accessible from the sidebar menu. Here, you first create and name your project. A project can have many systems, and a system can have many diagrams. For example, you might want to create a project called "Airline", which is split over several systems such as "Logistics", "Payments", "Marketing", "Maintenance", etc. Each of these systems might contain one or several class, use case or activity diagrams. These diagrams may or may not have common elements, like the class "Airplane" appearing in class diagrams in both the "Logistics" and the "Maintenance" systems. + +Once you have your project and system, you can get started working on a diagram. + +

+ Class Diagrams +

\ No newline at end of file From 4ee8ade95ef30f25032f193120fcb558f15a59ba Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 16:09:20 +0100 Subject: [PATCH 09/14] Diagrams guide --- docs/users-guide.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/users-guide.md b/docs/users-guide.md index 2cf1c919f..86f6a6d1f 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -1,4 +1,4 @@ -p align="center"> +

AI4MDE studio

- AI4MDE · Creating Diagrams + Working with Diagrams

You can create diagrams from scratch in the `Projects` section accessible from the sidebar menu. Here, you first create and name your project. A project can have many systems, and a system can have many diagrams. For example, you might want to create a project called "Airline", which is split over several systems such as "Logistics", "Payments", "Marketing", "Maintenance", etc. Each of these systems might contain one or several class, use case or activity diagrams. These diagrams may or may not have common elements, like the class "Airplane" appearing in class diagrams in both the "Logistics" and the "Maintenance" systems. @@ -16,4 +16,32 @@ Once you have your project and system, you can get started working on a diagram.

Class Diagrams -

\ No newline at end of file + + +

Classifiers and Nodes

+node vs. classifier +Creating and Editing +How to create, types of classes, parameters, how to edit. +Importing nodes from other systems +Why you would do this, how imported nodes are marked. +Removing and Deleting +Difference between remove and delete (node vs. classifier, case of imports). + +

Relations and Edges +edge vs. relation +Creating and Editing +How to create (connect option), types of connections, parameters, how to reposition edges using dog ears, how do delete dog earshow to edit. +Removing and Deleting +Difference between remove and delete (edge vs. relation). + +

+ Collaboration +

+ +Exporting and importing systems possible via JSON files. + +

Exporting A System

+From diagrams screen (not sure if this will work, check), from versions screen. + +

Importing A System

+From projects screen(not sure if this will work, check), from versions screen. \ No newline at end of file From cabb62187c5f5f126b5f14b2d14b7c5af52c4529 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Mon, 2 Feb 2026 16:10:11 +0100 Subject: [PATCH 10/14] Typo --- docs/users-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/users-guide.md b/docs/users-guide.md index 86f6a6d1f..99a26bdd5 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -27,7 +27,7 @@ Why you would do this, how imported nodes are marked. Removing and Deleting Difference between remove and delete (node vs. classifier, case of imports). -

Relations and Edges +

Relations and Edges

edge vs. relation Creating and Editing How to create (connect option), types of connections, parameters, how to reposition edges using dog ears, how do delete dog earshow to edit. From 23c08ef8d599e8c614fb19150cfedc96d0a5c7ca Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Tue, 3 Feb 2026 13:25:17 +0100 Subject: [PATCH 11/14] Node description --- docs/users-guide.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/users-guide.md b/docs/users-guide.md index 99a26bdd5..404083b4c 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -10,7 +10,7 @@ Working with Diagrams -You can create diagrams from scratch in the `Projects` section accessible from the sidebar menu. Here, you first create and name your project. A project can have many systems, and a system can have many diagrams. For example, you might want to create a project called "Airline", which is split over several systems such as "Logistics", "Payments", "Marketing", "Maintenance", etc. Each of these systems might contain one or several class, use case or activity diagrams. These diagrams may or may not have common elements, like the class "Airplane" appearing in class diagrams in both the "Logistics" and the "Maintenance" systems. +You can create diagrams from scratch in the `Projects` section accessible from the sidebar menu. Here, you first create and name your project. A project can have many systems, and a system can have many diagrams. For example, you might want to create a project called `Airline`, which is split over several systems such as `Logistics`, `Payments`, `Marketing`, `Maintenance`, etc. Each of these systems might contain one or several class, use case or activity diagrams. These diagrams may or may not have common elements, like the class `Airplane` appearing in class diagrams in both the `Logistics` and the `Maintenance` systems. Once you have your project and system, you can get started working on a diagram. @@ -18,14 +18,22 @@ Once you have your project and system, you can get started working on a diagram. Class Diagrams -

Classifiers and Nodes

-node vs. classifier +

Nodes

Creating and Editing -How to create, types of classes, parameters, how to edit. -Importing nodes from other systems -Why you would do this, how imported nodes are marked. +Nodes are the buidling blocks of class diagrams. By right clicking your modelling area, you have the option to create a new node representing a Class, Enum, Signal or Application. You will have to name your node. If you are creating an Enum, you can also use the create menu to specify your literals. By right clicking a node, you then have the option to edit it. This allows you to: +
    +
  • rename the node
    • +
  • edit attributes and methods for classes
    • +
  • edit literals for enums
    • +
+Importing Nodes from Other Systems +In the class diagram, you have the option to import nodes from other diagrams, and even from other systems within your project. The origin system is marked when it is different than the current one. Sometimes you are importing a node that in other diagrams has some preexisting edges connecting it to nodes that already exist in your current diagram. If that happens, these edges will be added to your current diagram as well. Removing and Deleting -Difference between remove and delete (node vs. classifier, case of imports). +You have two options in terms of removing a node: +
    +
  • Remove from Diagram: only deleted the node and its edges in the current diagram.
    • +
  • Delete Completely: removes the node and its edges in any diagram in your project.
    • +

Relations and Edges

edge vs. relation From 31c1f130acd1443085ad96c30e66a553313505cb Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Tue, 3 Feb 2026 13:58:44 +0100 Subject: [PATCH 12/14] Instructions edge --- docs/users-guide.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/users-guide.md b/docs/users-guide.md index 404083b4c..495bb1e54 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -20,36 +20,32 @@ Once you have your project and system, you can get started working on a diagram.

Nodes

Creating and Editing -Nodes are the buidling blocks of class diagrams. By right clicking your modelling area, you have the option to create a new node representing a Class, Enum, Signal or Application. You will have to name your node. If you are creating an Enum, you can also use the create menu to specify your literals. By right clicking a node, you then have the option to edit it. This allows you to: +

Nodes are the buidling blocks of class diagrams. By right-clicking your modelling area, you have the option to create a new node representing a Class, Enum, Signal or Application. You will have to name your node. If you are creating an Enum, you can also use the create menu to specify your literals. By right clicking a node, you then have the option to edit it. This allows you to:

  • rename the node
  • edit attributes and methods for classes
  • edit literals for enums
Importing Nodes from Other Systems -In the class diagram, you have the option to import nodes from other diagrams, and even from other systems within your project. The origin system is marked when it is different than the current one. Sometimes you are importing a node that in other diagrams has some preexisting edges connecting it to nodes that already exist in your current diagram. If that happens, these edges will be added to your current diagram as well. +

In the class diagram, you have the option to import nodes from other diagrams, and even from other systems within your project. The origin system is marked when it is different than the current one. Sometimes you are importing a node that in other diagrams has some preexisting edges connecting it to nodes that already exist in your current diagram. If that happens, these edges will be added to your current diagram as well.

Removing and Deleting -You have two options in terms of removing a node: +

You have two options in terms of removing a node:

    -
  • Remove from Diagram: only deleted the node and its edges in the current diagram.
    • +
  • Remove from Diagram: only deletes the node and its edges in the current diagram.
  • Delete Completely: removes the node and its edges in any diagram in your project.
+

This distinction is important when you have imported a node to multiple systems, and allows you to decide whether you want to delete it only from the current diagram or from everywhere in your project.

-

Relations and Edges

-edge vs. relation +

Edges

Creating and Editing -How to create (connect option), types of connections, parameters, how to reposition edges using dog ears, how do delete dog earshow to edit. -Removing and Deleting -Difference between remove and delete (edge vs. relation). - -

- Collaboration -

- -Exporting and importing systems possible via JSON files. +

You can create an edge by right-clicking on a source node and then selecting the `Connect` option, then selecting the target node. You can create different types of edges: Association, Generalization, Composition, Dependency. In the edge creation menu, you have the option of setting a label, as well as any eventual source/target label or multiplicity. You can right-click an edge and then select `Edit` in order to change all of these properties.

-

Exporting A System

-From diagrams screen (not sure if this will work, check), from versions screen. - -

Importing A System

-From projects screen(not sure if this will work, check), from versions screen. \ No newline at end of file +

You may be in the situation of having to reposition edges in order to avoid overlaps that can make the label, multiplicityes or edge type indistinguishable. You can drag the circular endpoints to reposition the edge. You can also add bending points by double-clicking a specific spot on the edge. These points are also draggable. If you wish to delete a bending point, you can do so by right-clicking it.

+How to create (connect option), types of connections, parameters, how to reposition edges using dog ears, how do delete dog ears how to edit. +Removing and Deleting +

When removing an edge, you have similar options as for a node:

+
    +
  • Remove from Diagram: only removes the edge from the current diagram.
    • +
  • Delete Completely: removes the edge from any diagram in your project.
    • +
+

Once again, this distinction is important when you have imported the same nodes to multiple systems, which can lead to imported edges that reoccur in multiple diagrams.

\ No newline at end of file From 60678a986e73582e8d744a1c3e53901c44ceda97 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Tue, 3 Feb 2026 14:45:05 +0100 Subject: [PATCH 13/14] Readme --- README.md | 31 ++++++++++++++++++++++--------- docs/users-guide.md | 14 +++++++------- 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 57b4ea971..0c8921bf8 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,33 @@ AI4MDE is an open-source research initiative at [LIACS](https://liacs.leidenuniv.nl/) that aims to bridge the gap between AI and Model-Driven Engineering. AI4MDE is a web-based environment in which users can design and manage UML Class, Activity, and Use Case Diagrams via a user-friendly interface. The platform provides the option to generate fully functional Django software prototypes from these diagrams. ## ⚡️ Quick start -Get up and running with the AI4MDE studio and API in no time: +To get up and running with the AI4MDE tool in no time, use the code below. For more explanations and environment requirements, read [docs/setup.md](./docs/setup.md) (you will need Docker, Git, and, if you are on Windows, WSL). -``` +```bash +# Ensure that you have the Docker installed +docker -v +docker compose version + +# Clone the repository git clone https://github.com/ai4mde/studio.git -cd frontend -docker-compose up -d +cd studio + +# Create secrets file +cp config/secrets.env.example config/secrets.env +# If you want, you can edit config/secrets.env, config/api.env, or config/prototypes.env at this point + +# Build and Start all the containers (add -d flag to start in background) +docker compose up -d --build + +# To stop the containers, you can use +docker compose down ``` Now visit [http://ai4mde.localhost](http://ai4mde.localhost) +The login credentials can be found in `config/api.env`. +For explanations on using the diagram modelling features, see [docs/users-guide.md](./docs/users-guide.md). -For a full tutorial on how to install AI4MDE, see: [setup.md](./docs/setup.md) - -For an overview of the technical architecture, see [architecture.md](./docs/architecture.md) -
+For an overview of the technical architecture, see [docs/architecture.md](./docs/architecture.md) -![Alt](https://repobeats.axiom.co/api/embed/80709bf7ea933c8ce8605ee6e8136a5f9420dcd6.svg "Repobeats analytics image") +You can report issues using our [bug reporting board](https://github.com/orgs/ai4mde/projects/12). This is public for viewing, but requires us to add you as a collaborator in order to post a new issue. Please, contact someone from the course support team in order to be added. diff --git a/docs/users-guide.md b/docs/users-guide.md index 495bb1e54..b56d5331f 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -20,7 +20,7 @@ Once you have your project and system, you can get started working on a diagram.

Nodes

Creating and Editing -

Nodes are the buidling blocks of class diagrams. By right-clicking your modelling area, you have the option to create a new node representing a Class, Enum, Signal or Application. You will have to name your node. If you are creating an Enum, you can also use the create menu to specify your literals. By right clicking a node, you then have the option to edit it. This allows you to:

+

Nodes are the buidling blocks of class diagrams. By right-clicking your modelling area, you have the option to create a new node representing a Class, Enum, Signal or Application. You will have to name your node. If you are creating an Enum, you can also use the create menu to specify your literals. By right clicking a node, you then have the option to edit it. This allows you to:

  • rename the node
  • edit attributes and methods for classes
    • @@ -31,21 +31,21 @@ Once you have your project and system, you can get started working on a diagram. Removing and Deleting

    You have two options in terms of removing a node:

      -
    • Remove from Diagram: only deletes the node and its edges in the current diagram.
      • -
    • Delete Completely: removes the node and its edges in any diagram in your project.
      • +
    • Remove from Diagram: only deletes the node and its edges in the current diagram.
      • +
    • Delete Completely: removes the node and its edges in any diagram in your project.

    This distinction is important when you have imported a node to multiple systems, and allows you to decide whether you want to delete it only from the current diagram or from everywhere in your project.

    Edges

    Creating and Editing -

    You can create an edge by right-clicking on a source node and then selecting the `Connect` option, then selecting the target node. You can create different types of edges: Association, Generalization, Composition, Dependency. In the edge creation menu, you have the option of setting a label, as well as any eventual source/target label or multiplicity. You can right-click an edge and then select `Edit` in order to change all of these properties.

    +

    You can create an edge by right-clicking on a source node and then selecting the Connect option, then selecting the target node. You can create different types of edges: Association, Generalization, Composition, Dependency. In the edge creation menu, you have the option of setting a label, as well as any eventual source/target label or multiplicity. You can right-click an edge and then select Edit in order to change all of these properties.

    You may be in the situation of having to reposition edges in order to avoid overlaps that can make the label, multiplicityes or edge type indistinguishable. You can drag the circular endpoints to reposition the edge. You can also add bending points by double-clicking a specific spot on the edge. These points are also draggable. If you wish to delete a bending point, you can do so by right-clicking it.

    -How to create (connect option), types of connections, parameters, how to reposition edges using dog ears, how do delete dog ears how to edit. + Removing and Deleting

    When removing an edge, you have similar options as for a node:

      -
    • Remove from Diagram: only removes the edge from the current diagram.
      • -
    • Delete Completely: removes the edge from any diagram in your project.
      • +
    • Remove from Diagram: only removes the edge from the current diagram.
      • +
    • Delete Completely: removes the edge from any diagram in your project.

    Once again, this distinction is important when you have imported the same nodes to multiple systems, which can lead to imported edges that reoccur in multiple diagrams.

    \ No newline at end of file From 24f6d7f31d9a53a5fb401cbd6384c35eb2f455d5 Mon Sep 17 00:00:00 2001 From: Irina Epure Date: Tue, 3 Feb 2026 14:52:23 +0100 Subject: [PATCH 14/14] Final changes --- README.md | 10 +++++----- docs/setup.md | 6 +++--- docs/users-guide.md | 2 ++ 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0c8921bf8..4a5652893 100644 --- a/README.md +++ b/README.md @@ -34,18 +34,18 @@ cd studio cp config/secrets.env.example config/secrets.env # If you want, you can edit config/secrets.env, config/api.env, or config/prototypes.env at this point -# Build and Start all the containers (add -d flag to start in background) +# Build and start all the containers (add -d flag to start in background) docker compose up -d --build # To stop the containers, you can use docker compose down ``` -Now visit [http://ai4mde.localhost](http://ai4mde.localhost) +Now visit [http://ai4mde.localhost](http://ai4mde.localhost). The login credentials can be found in `config/api.env`. -For explanations on using the diagram modelling features, see [docs/users-guide.md](./docs/users-guide.md). +- For explanations on using the diagram modelling features, see [docs/users-guide.md](./docs/users-guide.md). -For an overview of the technical architecture, see [docs/architecture.md](./docs/architecture.md) +- For an overview of the technical architecture, see [docs/architecture.md](./docs/architecture.md). -You can report issues using our [bug reporting board](https://github.com/orgs/ai4mde/projects/12). This is public for viewing, but requires us to add you as a collaborator in order to post a new issue. Please, contact someone from the course support team in order to be added. +- You can report issues using our [bug reporting board](https://github.com/orgs/ai4mde/projects/12). This is public for viewing, but requires us to add you as a collaborator in order to post a new issue. Please, contact someone from the course support team in order to be added. diff --git a/docs/setup.md b/docs/setup.md index 7ee4c4839..03cbaa843 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -53,6 +53,6 @@ docker compose down This will start multiple services in the background and set everything up (for development). As soon as that's done, you can find the following services on your machine's network: - [ai4mde.localhost](http://ai4mde.localhost) - Frontend, from `/frontend`. As a non-contributing user, this is where you can interact with the AI4MDE tool. Use the credentials from `config/api.env` to log in. -- [api.ai4mde.localhost](http://api.ai4mde.localhost) - API from `/api` -- [prototype.ai4mde.localhost](http://prototype.ai4mde.localhost) - Running prototype in `/prototypes/generated_prototypes` -- [prototypes_api.ai4mde.localhost](http://prototypes_api.ai4mde.localhost) - Prototype management API from `/prototypes/backend` +- [api.ai4mde.localhost](http://api.ai4mde.localhost) - API from `/api`. +- [prototype.ai4mde.localhost](http://prototype.ai4mde.localhost) - Running prototype in `/prototypes/generated_prototypes`. +- [prototypes_api.ai4mde.localhost](http://prototypes_api.ai4mde.localhost) - Prototype management API from `/prototypes/backend`. diff --git a/docs/users-guide.md b/docs/users-guide.md index b56d5331f..06d7b141b 100644 --- a/docs/users-guide.md +++ b/docs/users-guide.md @@ -36,6 +36,8 @@ Once you have your project and system, you can get started working on a diagram.

This distinction is important when you have imported a node to multiple systems, and allows you to decide whether you want to delete it only from the current diagram or from everywhere in your project.

+
+

Edges

Creating and Editing

You can create an edge by right-clicking on a source node and then selecting the Connect option, then selecting the target node. You can create different types of edges: Association, Generalization, Composition, Dependency. In the edge creation menu, you have the option of setting a label, as well as any eventual source/target label or multiplicity. You can right-click an edge and then select Edit in order to change all of these properties.