Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 2.4 KB

README.md

File metadata and controls

85 lines (58 loc) · 2.4 KB
Raw

Apollon iOS Module

Apollon-iOS-Module is a SPM package containing different modules, which allow for creating, editing, and viewing UML diagrams across all Artemis-related iOS apps. This package is based on Apollon.

Clients Overview

This package will be integrated into the following clients:

  • Artemis iOS – Native iOS application for Artemis
  • Themis – An iPad app that provides a comprehensive and optimized way for tutors to assess student submissions on the go.
  • Apollon iOS - A standalone modeling application that allows users to freely create, edit, and view UML diagrams from the comfort of their iOS device.

Modules

Overview

  • ApollonShared: Contains all data models used by Apollon
  • ApollonRenderer: Contains all the rendering logic
  • ApollonEdit: Allows for the editing of UML diagrams
  • ApollonView: Allows for the viewing of UML diagrams

Architecture

Subsystem decomposition of the Apollon-iOS-Module

Figure: Subsystem decomposition of the Apollon-iOS-Module.

Installation Guide

Swift Package Manager

Add to Xcode project

In Project Settings, on the tab "Package Dependencies", click "+" and add https://github.com/ls1intum/apollon-ios-module

Add to Package.swift based SPM project

  1. Add a dependency in Package.swift:
dependencies: [
    .package(url: "https://github.com/ls1intum/apollon-ios-module", .upToNextMajor(from: "1.0.2")),
]
  1. For each relevant target, add a dependency with the product name from section 1:
.target(
    name: "Example",
    dependencies: [
        .product(name: "ApollonEdit", package: "apollon-ios-module"),
    ]    
)

Usage

ApollonEdit

import ApollonEdit

ApollonEdit(umlModel: Binding<UMLModel>,
            diagramType: UMLDiagramType,
            fontSize: CGFloat,
            themeColor: Color,
            diagramOffset: CGPoint,
            isGridBackground: Bool)

ApollonView

import ApollonView

ApollonView(umlModel: UMLModel,
            diagramType: UMLDiagramType,
            fontSize: CGFloat,
            themeColor: Color,
            diagramOffset: CGPoint,
            isGridBackground: Bool,
            @ViewBuilder content: () -> Content)