Skip to content

Github Login & Editing

Jump to bottom
JulianStaab edited this page Apr 28, 2021 · 1 revision

Github Login & Editing is a feature for the VIAProMa project by Julian Staab and Emilie Hastrup-Kiil supervised by Ralf Klamma and Benedikt Hensen.

Description: With this feature it is possible for users to Login to Github in VIAProMa. It also provides several key features available on Github directly in VIAProMa such as Creating an Issue and Editing an existing Issue:

  • Login to Github - In the Main Menu, create a room and give it a name. Then you will be able to select "Issues" in the Main Menu, which will open the Issue Shelf. Via the DropDownMenu in the Configuration Menu select Github and click on the Login button at the bottom of the Configuration Menu. Your default browser will open a login page for you to login to. Enter your username and password and click "Login". You will be asked to return to the application and when you do, you will be logged in.

  • Creating a Issue - Having successfully logged in you should first select a project and a category in that project for which you want to create your Issue. After that, the "Create Issue" button which is located in the IssueShelf represented by a blank issue card with a plus, should turn white and active. Clicking on it will open the CreateIssue Menu, which allows you to enter a title and a description for your new Issue. Pressing done in this window will create the Issue in Github and also add it to the IssueShelf in VIAProMa.

  • Editing a Issue - Having successfully logged in you should first select a project and optionally a category in which the desired Issue is contained in. After that, the "Edit Issue" button in the form of a small gear symbol will appear over each Issue. Clicking on it will open the EditIssue Menu, which allows you to change the title and description of the chosen Issue. Pressing done in this window will execute the changes to the Issue in Github and also change it in the IssueShelf in VIAProMa.

How to use this feature: To use this feature, you first need to create your Github login credentials in the form of a client ID and client secret. To do this, first register a new app in the GitHub Developer Settings: OAuth Apps. During this process, set the Homepage URL to http://127.0.0.1 and Authorization callback URL to http://127.0.0.1 and then GitHub will generate a Client ID and Client Secret for your application. To define the client credentials in VIAProMa, right-click somewhere in your Assets folder and choose "Create > i5 Toolkit > OpenID Connect Client Data" to create the file. It is important that you do this directly in the Assets folder such that this object is ignored by the .gitignore when pushing to github. For the same reason you should also rename the object to GithubOpenIDConnectClientData. If you select the created object, you can enter the client credentials in Unity's inspector. After that, search the Assets folder for the "IssueShelf" Prefab and open it. Navigate to "IssueShelf > Configuration Window > Github > Button Login", select it and pull the ClientCredentials object into the designated field of the LearningLayersLogin script.

Overview:

  • gitHub_issueEditing - This branch contains the current and latest version of the Github Login & Editing Feature. Once completed, it is scheduled to be merged into the develop branch.

To find out how to use these features for RequirementsBazaar, read the RequirementsBazaar Login & Editing chapter.

  1. Home

  2. User Manual

    1. Main Menu
    2. Network Connection
    3. Shared Environment
      1. Room System
      2. Avatars
      3. Chat System
      4. Voice Chat
    4. Task Card Import
    5. Visualizations
      1. Kanban Board Column
      2. Progress Bar
      3. Building Progress Bar
      4. Competence Display
      5. Commit Statistics
      6. Heatmap
        1. Heatmap Visualizer
        2. Heatmap Data Management
      7. Sticky Notes
      8. Polls
      9. Minimap
    6. Saving and Loading
    7. Connection Lines
    8. Gaze Visualization
    9. Virtual Environments
    10. RequirementsBazaar Login & Editing
    11. GitHub Login & Editing
    12. Mockup-Editor
    13. Menu Placement System
    14. GuidedTour
    15. Invite Links
    16. 3D Model Import

  3. Code Documentation

    1. Adding Virtual Environments
    2. Menu Placement System Development Guide
    3. GuidedTour Configuration
    4. Deep Links
Clone this wiki locally