Giter Club home page Giter Club logo

prototyper's Introduction

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.

prototyper's People

Contributors

killertoast avatar pschmiedmayer avatar raypinto avatar sibomuc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

prototyper's Issues

Add feedback adapters that send out feedback to different tools

A feedback adapter should provide some functions that can receive feedback and send it out to a service. The adapter also has a way to verify credentials or provide e.g. an API key itself. This should allow other services than Prototyper to receive Feedback.
An example would be a JIRA feedback adapter.

Documentation

Add a documentation for all public facing interfaces and automatically generate the documentation using GitHub pages. The goal is a 100% documentation coverage and the documentation should be generated on every new release using GitHub Actions.

Continue with login text is wrong

image

The continue with and without login texts are exactly the wrong way around. It should say continue without login in the view that prompts the user to log in

The sending feedback view does not appear, if one chooses to continue without a login

There is a problem with sending feedback without logging in. After you have entered your name, the sending view does not appear. Interestingly the feedback will be sent, if you hit cancel and push the send button again. So the model gets updated correctly but the necessary view does not appear 🤔
The corresponding test class is called PrototyperContinueWithoutLoginTest
Bildschirmvideo aufnehmen 2020-09-29 um 14 55 46

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.