Skip to content

Framework that allows you to integrate prototypes into an iOS application and receive feedback using the Prototyper service

License

Notifications You must be signed in to change notification settings

ls1intum/Prototyper

Repository files navigation

Prototyper

Swift Package Manager compatible platforms license

The Prototyper Framework allows you to integrate prototypes into an iOS application and receive feedback using Prototyper service. When you deploy an application using the Prototyper service the Prototyper Framework allows users to send feedback from within the application.

Example

Open PrototyperExample.xcodeproj under the Example directory to test the Prototyper framework. You can find here the list of globally available classes. To work on the framework, open the Prototyper directory in xcode, which opens as a swift package.

Requirements

To use the Prototyper framework you need an account at the Prototyper online service. Your users can use the feedback button to give feedback and share the application with other users. The feedback will be displayed on the website of the Prototyper service.

Installation

  1. Add the Prototyper framework to your application as a swift package dependency. Follow the instructions specified here and use https://github.com/ls1intum/Prototyper.git as the package respository URL.

  2. Display the feedback button by using the .prototyper(settings: PrototyperSettings) modifier. If you add it to the ContentView, the button will be visible until you disable it. You can configure the Prototyper framework using the PrototyperSettings struct.

    import SwiftUI
    import Prototyper
    @main
    struct ExampleApp: App {
        var body: some Scene {
            WindowGroup {
                ContentView()
                    .prototyper(PrototyperSettings.default)
            }
        }
    }
  3. Deploy your application e.g. using the Prototyper service found at https://prototyper.ase.in.tum.de

Authors

License

Prototyper is available under the MIT license. See the LICENSE file for more info. Prototyper wurde initital im Rahmen des vom BMBF geförderten Softwarecampus Projekt ProCeeD unter der Leitung von Dr. Lukas Alperowitz entwickelt.

About

Framework that allows you to integrate prototypes into an iOS application and receive feedback using the Prototyper service

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •