Skip to main content

Using the Program

Website Usage​

Current hosted at Clover.nickrucinski.com

Without signing in all users can access

After signing in the user will have access to their dashboard. Their are currently four different dashboards:

  • Student
    • The student dashboard can be filtered based on all classes, a specific class, or coding activities that were done outside of class using the drop down in the top right
    • The rest of the dashboard gives various charts and graphs that show their usage statistics
  • Instructor
    • The instructor dashboard can be filtered using the drop down in the top right to only show details for a specific class
    • In the top left there is a button to create a new class that has a form to fill in data about the new class and a color
    • The rest of the dashboard gives various charts and graphs that show information about their classes
  • Admin
    • Gives a list view of users signed up that can be filtered by role, name, or status
    • When a user is clicked on it shows their information including logs and any classes they belong to or instruct
    • At the bottom of the user data is a section for settings that can be changed to effect how the extension will operate
      • If these settings are changed the user will need to restart the extension or re-login for them to take effect
  • Developer
    • Gives the most details but is only for usage within the team for debugging

Each level of access also has access to the roles below them so an admin can still access their student dashboard and use the application normally.

Also when the user is signed in their profile image will take the place of the sign in and out buttons and this is where they can:

  • Sign out
  • View/Edit their profile

Extension Usage​

The extension is only for the Visual Studio Code editor.

The extension can be downloaded by going to the extension tab within VSCode and searching for Temple Capstone Clover or by visiting this link. It should automatically open VSCode for you if its installed.

When first starting the extension a new UI element will show up along the bottom bar on the right telling you to sign in. Clicking this will take you to your VSCode command palette where you are directed through a menu to either sign in or sign up. After authenticating, you are able to open a file and start getting code suggestions. In the bottom right there is a pair of curly braces that turn into spinning arrows when the editor is waiting for a response and sometimes it can take a little bit of time. All suggestions at this point will go your Non-Class Activities section. If you have signed up for a class, it can be picked using the "SELECT CLASS" button on the bottom bar of the editor on the left. This will show a view of all classes you are registered for and associated all code suggestions with that class.

Extension Commands​

VSCode commands can be accessed with the command palette. This is either accessed by clicking the search bar at the top of the screen and and adding a > before searching for the command or by using the keybind CTRL+SHIFT+P(Windows/Linux) and CMD+SHIFT+P(Mac).

  • Clover: Sign In to Clover
    • Handles the sign in and sign up menu
  • Clover: Sign Out of Clover
    • Signs you out of the extension if you are signed in
  • Clover: Fetch Settings
    • Used to get new settings that were changed on the website while the extension was being used
  • Debug: Test fetchSuggestions
    • Debug command to test if the connection to the AI is working

Extension Keybinds​

  • Accept Code Suggestion
    • Tab(Window/Mac/Linux)
  • Reject Code Suggestion
    • CMD+R(Mac)
    • CTRL+Space(Windows/Linux)

Extension Settings​

Extension settings can be modified in VSCode settings using the shortcut CTRL+,

Alternatively you can navigate to File>Preferences>Settings>User>Extensions in the top menu bar.

They will be found under the Clover section. These were originally to change the model being used on the backend but they have been deprecated for now.