Developer Documentation added

docs/developer/index.md

@@ -0,0 +1,81 @@
+# A Developer's Guide
+
+This guide is to help developers get familiar with the project. 
+
+## Software Overview
+
+* [Slides](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/DTaaS-overview.pdf)
+* [Video](https://odin.cps.digit.au.dk/into-cps/dtaas/assets/videos/DTaaS-overview.mkv)
+* [Research paper draft](https://arxiv.org/abs/2305.07244)
+
+## Operating Softwares
+
+Ideally, developers should work on Ubuntu/Linux. Other operating systems are not supported inherently and may require additional steps.
+
+## Code Editing
+Any popular code editors can be used to work on the project. VS Code, Sublime Text are a few examples. 
+
+## Development Workflow
+
+To manage collaboration by multiple developers on the software, a simple [Fork, Branch, PR](https://gun.io/news/2017/01/how-to-github-fork-branch-and-pull-request/) development workflow is in place. Each developer should follow these steps:
+
+1. Have an updated fork of the main repository on their account. This should also be added to codeclimate. 
+1. Clone your personal fork onto your computer.
+    ```
+    git clone https://github.com/<yourgithubusername>/DTaaS.git
+    ```
+1. Work on your issue/feature on your personal computer. 
+
+1. Once changes are made, they should be tested on personal systems or the [integration server](https://github.com/INTO-CPS-Association/DTaaS/wiki/DTaaS-Integration-Server) .
+
+1. Any updates/additions to the software should first be committed to your personal fork.
+
+    1. To check status of your changes:
+        ```
+        git status
+        ```
+    2. Add the changes to the commit:
+        ```
+        git add --all *
+        ```
+    3. Finally, commit these to the repository on your PC.
+        ```
+        git commit -m <commit message>
+        ```
+1. Push any commits onto your fork of the repository
+    ```
+    git push
+    ```
+
+1. Any issues taht arise codeclimate should also be resolved. 
+1. Once changes are verified, a PR should be made to the appropriate branch of the main repository.
+1. Any issues raised in the PR review should be resolved. 
+1. Finally, the PR will be merged.
+
+Remember that every commit should be meaningful and satisfies the requirements.
+
+Additionally, please go through the two workflows specified in the diagram below:
+
+![Alt text](workflow.png)
+
+## Code Quality
+
+Quality checks are performed by CodeClimate to ensure the best possible quality of code to add to our project.
+
+While any new issues introduced in your code would be shown in the PR page itself, to address any specific issue, you can visit the Issues or Code section of the CodeClimate page.
+
+It is highly recommended that any code you add does not introduce new quality issues. If they are introduced, they should be fixed immediately using the appropriate suggestions from CodeClimate, or in worst case, adding a ignore flag (To be used with caution).
+
+## Testing
+
+For information about testing and workflow related to that, please see the [testing folder](docs\developer\testing).
+
+## Live Demo Server
+
+A demo server is up and running at [https://sandbox.cps.digit.au.dk/](https://sandbox.cps.digit.au.dk/). Developers will need credentials to log in. 
+
+## License
+
+This software is owned by [The INTO-CPS Association](https://into-cps.org/) and is available under [the INTO-CPS License](LICENSE.md).
+
+The DTaaS software platform uses [Træfik](https://github.com/traefik/traefik), [ML Workspace](https://github.com/ml-tooling/ml-workspace), [Grafana](https://github.com/grafana/grafana), [InfluxDB](https://github.com/influxdata/influxdb) and [RabbitMQ](https://github.com/rabbitmq/rabbitmq-server) open-source components. These software components have their own licenses.

docs/developer/servers/lib/lib-class.mmd

@@ -0,0 +1,46 @@
+classDiagram
+    class FilesResolver {
+    -filesService: IFilesService
+    +listDirectory(path: string): Promise<Project>
+    +readFile(path: string): Promise<Project>
+    }
+
+    class FilesServiceFactory {
+    -configService: ConfigService
+    -gitlabFilesService: GitlabFilesService
+    -localFilesService: LocalFilesService
+    +create(): IFilesService
+    }
+
+    class GitlabFilesService {
+    -configService: ConfigService
+    -parseArguments(path: string): Promise<domain: string; parsedPath: string>
+    -sendRequest(query: string): Promise<Project>
+    -executeQuery(path: string, getQuery: QueryFunction): Promise<Project>
+    +listDirectory(path: string): Promise<Project>
+    +readFile(path: string): Promise<Project>
+    }
+
+    class LocalFilesService {
+    -configService: ConfigService
+    -getFileStats(fullPath: string, file: string): Promise<Project>
+    +listDirectory(path: string): Promise<Project>
+    +readFile(path: string): Promise<Project>
+    }
+
+    class ConfigService {
+    +get(propertyPath: string): any
+    }
+
+    class IFilesService{
+    listDirectory(path: string): Promise<Project>
+    readFile(path: string): Promise<Project>
+    }
+
+    IFilesService <|-- FilesResolver: uses
+    IFilesService <|.. GitlabFilesService: implements
+    IFilesService <|.. LocalFilesService: implements
+    IFilesService <|-- FilesServiceFactory: creates
+    ConfigService <|-- FilesServiceFactory: uses
+    ConfigService <|-- GitlabFilesService: uses
+    ConfigService <|-- LocalFilesService: uses

docs/developer/servers/lib/lib-sequence.mmd

@@ -0,0 +1,99 @@
+sequenceDiagram
+    actor Client
+    actor Traefik
+
+    box Aqua RAMS
+    participant FR as FilesResolver
+    participant FSF as FilesServiceFactory
+    participant CS as ConfigService 
+    participant IFS as IFilesService
+    participant LFS as LocalFilesService
+    participant GFS as GitlabFilesService
+    end
+
+    participant FS as Local File System DB
+    participant GAPI as GitLab API DB
+
+    Client -> Traefik : HTTP request
+    Traefik -> FR : GraphQL query
+    activate FR
+
+    FR -> FSF : create()
+    activate FSF
+
+    FSF -> CS : getConfiguration("MODE")
+    activate CS
+
+    CS --> FSF : return configuration value
+    deactivate CS
+
+    alt MODE = Local
+    FSF -> FR : return filesService (LFS)
+    deactivate FSF
+
+    FR -> IFS : listDirectory(path) or readFile(path)
+    activate IFS
+
+    IFS -> LFS : listDirectory(path) or readFile(path)
+    activate LFS
+
+    LFS -> CS : getConfiguration("LOCAL_PATH")
+    activate CS
+
+    CS --> LFS : return local path
+    deactivate CS
+
+    LFS -> FS : Access filesystem
+    alt Filesystem error
+        FS --> LFS : Filesystem error
+        LFS -> LFS : Throw new InternalServerErrorException
+        LFS --> IFS : Error
+    else Successful file operation
+        FS --> LFS : Return filesystem data
+        LFS -> IFS : return Promise<Project>
+    end
+    deactivate LFS
+    else MODE = GitLab
+        FSF -> FR : return filesService (GFS)
+        %%deactivate FSF
+
+    FR -> IFS : listDirectory(path) or readFile(path)
+    activate IFS
+
+    IFS -> GFS : listDirectory(path) or readFile(path)
+    activate GFS
+
+    GFS -> GFS : parseArguments(path)
+    GFS -> GFS : executeQuery()
+
+    GFS -> CS : getConfiguration("GITLAB_API_URL", "GITLAB_TOKEN")
+    activate CS
+
+    CS --> GFS : return GitLab API URL and Token
+    deactivate CS
+
+    GFS -> GAPI : sendRequest()
+    alt GitLab API error
+        GAPI --> GFS : API error
+        GFS -> GFS : Throw new Error("Invalid query")
+        GFS --> IFS : Error
+    else Successful GitLab API operation
+        GAPI --> GFS : Return API response
+        GFS -> IFS : return Promise<Project>
+    end
+    deactivate GFS
+    end
+
+    alt Error thrown
+    IFS -> FR : return Error
+    deactivate IFS
+    FR -> Traefik : return Error
+    Traefik -> Client : HTTP error response
+    else Successful operation
+    IFS -> FR : return Promise<Project>
+    deactivate IFS
+    FR -> Traefik : return Promise<Project>
+    Traefik -> Client : HTTP response
+    end
+
+    deactivate FR

docs/developer/system/architecture.md

@@ -0,0 +1,47 @@
+# System  Architecture
+![System architecture](architecture.png)
+##  User Requirements
+
+The DTaaS software platform users expect a single platform
+to support the complete DT lifecycle. To be more precise, the platform users expect the following features:
+
+1. Author – create different assets of the DT on the
+platform itself. This step requires use of some software
+frameworks and tools whose sole purpose is to author
+DT assets.
+1. Consolidate – consolidate the list of available DT assets
+and authoring tools so that user can navigate the library
+of reusable assets. This functionality requires support
+for discovery of available assets.
+3. Configure – support selection and configuration of
+DTs. This functionality also requires support for validation of a given configuration.
+4. Execute – provision computing infrastructure on demand to support execution of a DT.
+5. Explore – interact with a DT and explore the results
+stored both inside and outside the platform. Exploration
+may lead to analytical insights.
+6. Save – save the state of a DT that’s already in the
+execution phase. This functionality is required for ondemand saving and re-spawning of DTs.
+7. What-if analysis – explore alternative scenarios to (i)
+plan for an optimal next step, (ii) recalibrate new DT
+assets, (iii) automated creation of new DTs or their
+assets; these newly created DT assets may be used to
+perform scientifically valid experiments.
+8. Share – share a DT with other users of their organisation.
+
+##  System Components
+
+The figure shows the system architecture of the the DTaaS software platform. The main domains of this architecture are:
+
+1. [The Website](docs\developer\system\client.md)
+
+2. [The Gateway](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/servers/config/gateway#the-gateway-server) - This is the single point of entry for direct access to the platform services. The gateway is responsible for controlling user access to the microservice components.
+
+3. [The Library Microservice](docs\developer\system\lib-ms.md)
+
+## C4 architecture Level 1
+![Alt text](c4l1.png)
+
+## C4 architecture Level 3 
+![Detailed C4 architecture](c4l3.png)
+
+

docs/developer/system/client.md

@@ -0,0 +1,11 @@
+# Website
+
+The [Website](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/client#readme) is how the end-users interact with the software platform. 
+
+This is the Client side (frontend) for Digital Twin as a Service (DTaaS) software. The software provides a React single page web application for the Digital Twin support platform.
+
+## Client Architecture
+
+```mermaid
+
+```