Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General: Redesign the course overview #9221

Merged
merged 39 commits into from
Oct 3, 2024

Conversation

edkaya
Copy link
Contributor

@edkaya edkaya commented Aug 15, 2024

Checklist

General

Client

  • I strictly followed the client coding and design guidelines.
  • Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Motivation and Context

Since the current design of the course overview page lacks user-friendliness, the pre-designed course cards will be im-
plemented to make the page appear cleaner and more structured. This implementation is a part of the new design for course overview page.

Description

  • Changed course card sizes and border design
  • Changed the way of displaying information of the score and next exercise
  • Added Manage Course button for tutors, editors and instructors to navigate to the corresponding course management page

Steps for Testing

Prerequisites:

  • 1 Student
  • 1 Tutor || Admin || Editor || Instructor
  1. Log in to Artemis with student account
  2. Verify that the course cards look good
  3. Verify that the course cards are responsive in case of size changes of page in width
  4. Verify that you can navigate to the exercise by clicking on the exercise title under the "Next Exercise"
  5. Log in to Artemis with Tutor || Admin || Editor || Instructor account
  6. Verify that you can see manage course button
  7. Verify that manage course button works as expected

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Screenshots

Before
Screenshot 2024-08-15 at 20 18 48

After
Screenshot 2024-08-23 at 17 51 34

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced course management interface with a new management button for direct access.
    • Introduced new methods to manage the state of the course overview.
  • User Interface Improvements

    • Modernized the layout and design of the course card component with improved flexibility and visual clarity.
    • Enhanced pie chart representation and refined statistics display logic for better user feedback.
    • Improved responsive design across various screen sizes for better usability.
    • Updated HTML structure in the course overview component for better visual distinction and modernity.
    • Introduced a grid layout for course cards, enhancing adaptability and aesthetics.
    • Enhanced localization for both German and English versions of the student dashboard.
  • Bug Fixes

    • Resolved issues related to state management of the course overview display.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Aug 15, 2024
@edkaya edkaya marked this pull request as ready for review August 20, 2024 18:06
@edkaya edkaya requested a review from a team as a code owner August 20, 2024 18:06
Copy link

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent updates implement a state management system for the course overview using a BehaviorSubject, enhance user interface components, and improve responsive layouts. Key modifications include new methods for managing the course overview background, refinements to the layout and styling of course cards, and updates to the courses component, ensuring a more cohesive and responsive design throughout the application.

Changes

Files & Changes Summary
src/main/webapp/app/course/manage/course-management.service.ts: Introduced BehaviorSubject for managing course overview state with methods to enable and disable the overview background.
src/main/webapp/app/overview/course-card.component.html, src/main/webapp/app/overview/course-card.scss: Enhanced layout and visual design, added management button; simplified conditional rendering and text handling.
src/main/webapp/app/overview/courses.component.html, src/main/webapp/app/overview/courses.component.scss: Improved HTML structure and responsive design for better visual presentation, including lifecycle method updates.
src/main/webapp/i18n/de/student-dashboard.json, src/main/webapp/i18n/en/student-dashboard.json: Updated localization strings for improved clarity and added new entries for performance metrics and course management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CourseManagementService
    participant CourseCardComponent
    participant CoursesComponent

    User->>CourseManagementService: Enable Course Overview
    CourseManagementService-->>User: Course Overview Activated
    User->>CourseCardComponent: View Course Card
    CourseCardComponent-->>User: Display Course Details
    User->>CoursesComponent: Access Courses
    CoursesComponent-->>User: Show List of Courses
Loading

Possibly related issues


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot previously approved these changes Aug 20, 2024
Copy link
Contributor

@janthoXO janthoXO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested on ts1

@krusche krusche modified the milestones: 7.5.3, 7.5.4 Sep 18, 2024
Copy link

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

@edkaya edkaya removed the stale label Sep 27, 2024
@krusche krusche modified the milestones: 7.5.4, 7.5.5 Sep 27, 2024
@krusche krusche modified the milestones: 7.5.5, 7.5.6 Sep 29, 2024
@krusche krusche changed the title General: Redesign the user interface of course cards General: Redesign the course overview Oct 3, 2024
@krusche krusche merged commit 0c12f24 into develop Oct 3, 2024
56 of 58 checks passed
@krusche krusche deleted the feature/general/redesign-course-cards branch October 3, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge too-long-open !!! This is an antipattern, we should aim for small PRs that are only open for a short time !!! user interface
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.